GetSessionHandle Method in Class SMS_SiteControlFile

Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2

In Configuration Manager, the GetSessionHandle Windows Management Instrumentation (WMI) class method creates an in-memory copy of the site control file (SCF) on which to work.

The following syntax is simplified from Managed Object Format (MOF) code, and it is intended to show the definition of the method.

SInt32 GetSessionHandle(
   String SessionHandle
);

Parameters

  • SessionHandle
    Data type: String

    Qualifiers: [out]

    Handle to the in-memory copy of the site control file.

Return Values

An SInt32 data type that is 0 to indicate success or non-zero to indicate failure.

For information about handling returned errors, see About Configuration Manager Errors.

Remarks

Multiple administrators can modify the site control file at the same time. As a result the SMS Provider manages simultaneous changes to the file by using session handles. The session handle identifies an in-memory copy of the site control file and identifies the changes made to the file.

Your application must pass the session handle as a context qualifier in all IWbemServices, SWbemServices, IWbemClassObject, and SWbemObject methods that are related to the site control file. For more information, see Configuration Manager Context Qualifiers.

Requirements

Runtime Requirements

For more information, see Configuration Manager Server Runtime Requirements.

Development Requirements

For more information, see Configuration Manager Server Development Requirements.

See Also

Concepts

SMS_SiteControlFile Server WMI Class
ReleaseSessionHandle Method in Class SMS_SiteControlFile
About the Configuration Manager Site Control File
Configuration Manager Context Qualifiers