Deployment Tools Foundation
Session Class
The Session object controls the installation process. It opens the
install database, which contains the installation tables and data.
Declaration Syntax| C# | Visual Basic | Visual C++ | F# |
public sealed class Session : InstallerHandle, IFormatProvider
Public NotInheritable Class Session Inherits InstallerHandle Implements IFormatProvider
public ref class Session sealed : public InstallerHandle, IFormatProvider
[<SealedAttribute>] type Session = class inherit InstallerHandle interface IFormatProvider end
Members| All Members | Methods | Properties | |||
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
Close()()()() |
Closes the handle. After closing a handle, further method calls may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
Components |
Gets an accessor for components in the current session.
|
|
|
CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
|
|
CustomActionData |
Gets custom action data for the session that was supplied by the caller.
|
|
|
Database |
Gets the Database for the install session.
|
|
Dispose(Boolean) |
Closes the session handle. Also closes the active database handle, if it is open.
After closing a handle, further method calls may throw an InvalidHandleException.
(Overrides InstallerHandle.Dispose(Boolean).) |
|
|
Dispose()()()() |
Closes the handle. After closing a handle, further method calls may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
|
DoAction(String) |
Executes a built-in action, custom action, or user-interface wizard action.
|
|
|
DoAction(String, CustomActionData) |
Executes a built-in action, custom action, or user-interface wizard action.
|
|
|
DoActionSequence(String) |
Executes an action sequence described in the specified table.
|
|
|
Equals(Object) |
Tests whether this handle object is equal to another handle object. Two handle objects are equal
if their types are the same and their native integer handles are the same.
(Inherited from InstallerHandle.) |
|
|
EvaluateCondition(String) |
Evaluates a logical expression containing symbols and values.
|
|
|
EvaluateCondition(String, Boolean) |
Evaluates a logical expression containing symbols and values, specifying a default
value to be returned in case the condition is empty.
|
|
|
Features |
Gets an accessor for features in the current session.
|
|
|
Finalize()()()() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
Format(String) |
Formats a string containing installer properties.
|
|
|
FormatRecord(Record) |
Returns a formatted string from record data.
|
|
|
FormatRecord(Record, String) | Obsolete.
Returns a formatted string from record data using a specified format.
|
|
FromHandle(IntPtr, Boolean) |
Creates a new Session object from an integer session handle.
|
|
|
GetHashCode()()()() |
Gets a hash value for the handle object.
(Inherited from InstallerHandle.) |
|
|
GetLifetimeService()()()() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
|
|
GetMode(InstallRunMode) |
Gets the designated mode flag for the current install session.
|
|
|
GetProductProperty(String) |
Retrieves product properties (not session properties) from the product database.
|
|
|
GetSourcePath(String) |
Gets the full path to the designated folder on the source media or server image.
|
|
|
GetTargetPath(String) |
Gets the full path to the designated folder on the installation target drive.
|
|
|
GetTotalCost()()()() |
Gets the total disk space per drive required for the installation.
|
|
|
GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
|
|
Handle |
Gets the native integer handle.
(Inherited from InstallerHandle.) |
|
|
InitializeLifetimeService()()()() | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
|
|
IsClosed |
Checks if the handle is closed. When closed, method calls on the handle object may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
|
Item[([( String])]) |
Gets or sets the string value of a named installer property, as maintained by the
Session object in the in-memory Property table, or, if it is prefixed with a percent
sign (%), the value of a system environment variable for the current process.
|
|
|
Language |
Gets the numeric language ID used by the current install session.
|
|
|
Log(String) |
Writes a message to the log, if logging is enabled.
|
|
|
Log(String, array<Object>[]()[][]) |
Writes a formatted message to the log, if logging is enabled.
|
|
|
MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
|
|
MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
Message(InstallMessage, Record) |
Performs any enabled logging operations and defers execution to the UI handler
object associated with the engine.
|
|
|
SetInstallLevel(Int32) |
Sets the install level for the current installation to a specified value and
recalculates the Select and Installed states for all features in the Feature
table. Also sets the Action state of each component in the Component table based
on the new level.
|
|
|
SetMode(InstallRunMode, Boolean) |
Sets the designated mode flag for the current install session.
|
|
|
SetTargetPath(String, String) |
Sets the full path to the designated folder on the installation target drive.
|
|
|
ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
|
|
VerifyDiskSpace()()()() |
Checks to see if sufficient disk space is present for the current installation.
|
RemarksThis object is associated with a standard set of action functions, each performing particular operations on data from one or more tables. Additional custom actions may be added for particular product installations. The basic engine function is a sequencer that fetches sequential records from a designated sequence table, evaluates any specified condition expression, and executes the designated action. Actions not recognized by the engine are deferred to the UI handler object for processing, usually dialog box sequences.
Note that only one Session object can be opened by a single process.
Inheritance Hierarchy| Object | |||
|
MarshalByRefObject | ||
|
|
InstallerHandle | ||
|
|
Session | ||
Assembly: Microsoft.Deployment.WindowsInstaller (Module: Microsoft.Deployment.WindowsInstaller.dll) Version: 3.0.0.0 (3.11.1.2318)