SMS_SiteControlFile

  • Article

The SMS_SiteControlFile WMI class represents the site control file (SCF) and contains methods to maintain version control of the SCF. Use classes derived from SMS_SiteControlItem to modify the SCF.

The following syntax is simplified from MOF code and includes all inherited properties.

Class SMS_SiteControlFile : SMS_BaseClass
{
  string BuildNumber;
  uint32 FileType;
  string FormatVersion;
  string SCFData;
  uint32 SerialNumber;
  string SiteCode;
};

Properties

  • BuildNumber
    Data type: string
    Access type: Read-only
    Qualifiers: Lazy

    SMS build number.

  • FileType
    Data type: uint32
    Access type: Read-only
    Qualifiers: Key

    Type of site control file. This property is no longer used for queries. Values are:
    EMPTY (0)
    ACTUAL (1)
    PROPOSED (2)
    TRANSACTIONS (4)
    LOCAL_TRANSACTIONS (6)
    1XSTYLE (7)

  • FormatVersion
    Data type: string
    Access type: Read-only
    Qualifiers: Lazy

    Version of the site control file format.

  • SCFData
    Data type: string
    Access type: Read-only
    Qualifiers: Lazy

    Current site control file data in text format (accumulated deltas).

  • SerialNumber
    Data type: uint32
    Access type: Read-only
    Qualifiers: Key

    Version number of the file itself. The number is incremented every time the file changes.

  • SiteCode
    Data type: string
    Access type: Read-only
    Qualifiers: Key

    Site code of the site associated with this site control file.

Methods

The following table lists the methods in SMS_SiteControlFile.

Method Description
Commit This method is obsolete.
CommitSCF Applies your changes to the SMS database. This method replaces the Commit method.
GetCurrentVersion Retrieves the full text of the site control file from memory.
GetNextID Reserved.
GetSessionHandle Gets an in-memory copy of the site control file and a session handle. Place the session handle in a context object and pass it to all services and object methods.
Refresh This method is obsolete.
RefreshSCF Refreshes your in-memory copy of the site control file with any recent changes from the SMS database. This method replaces the Refresh method.
ReleaseSessionHandle Releases your in-memory copy of the site control file and any resource associated with your session handle.
SetNextID Reserved.

Remarks

You do not use this class to access the contents of the site control file. Instead, you use the methods of this class to perform version control of the site control file. To update the contents of the site control file, use classes derived from SMS_SiteControlItem. For more information, see Managing Site Control Configuration.

See Also

Site Configuration Classes, SMS_SiteControlItem, Managing Site Control Configuration