Share via

SMS_PDF_Program

  • Article

The SMS_PDF_Program WMI class represents a template from which programs can be created. The programs are initialized with the data from the PDF. The SMS_PDF_Package class contains methods used to store the PDF template in the PDF store and produce objects of type SMS_Package and SMS_Program from templates.

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

Class SMS_PDF_Program : SMS_BaseClass
{
  string CommandLine;
  string Comment;
  string DependentProgram;
  string Description;
  string DiskSpaceReq;
  string DriveLetter;
  uint32 Duration;
  uint8 Icon[];
  uint32 IconSize;
  uint32 PDFID;
  uint32 ProgramFlags;
  string ProgramName;
  string Publisher;
  string Requirements;
  string WorkingDirectory;
};

Properties

  • CommandLine
    Data type: string
    Access type: Read-only

    Command that executes when the program is launched.

  • Comment
    Data type: string
    Access type: Read-only

    Description of the program displayed in the SMS console.

  • DependentProgram
    Data type: string
    Access type: Read-only

    String representing a formatted text string defining any program that should be run prior to execution of the current program. The format is defined as: <PackageID>;; <ProgramName>.

  • Description
    Data type: string
    Access type: Read-only

    Description of the program (not displayed in the console).

  • DiskSpaceReq
    Data type: string
    Access type: Read-only

    Approximate disk space the program requires.

  • DriveLetter
    Data type: string
    Access type: Read-only

    Drive letter (one character in the range a-z) the program maps to and runs from when it is executed.

  • Duration
    Data type: uint32
    Access type: Read-only

    Approximate duration of time, in minutes, that the program takes to execute.

  • Icon
    Data type: uint8[]
    Access type: Read-only
    Qualifiers: Lazy

    Icon to associate with the program. The icon is displayed in the console.

  • IconSize
    Data type: uint32
    Access type: Read-only
    Qualifiers: Lazy

    Size of the icon (bytes).

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

    Identifier of the SMS_PDF_Package instance to which this program belongs.

  • ProgramFlags
    Data type: uint32
    Access type: Read-only

    Defines the installation characteristics of the program, such as whether this is an unattended install, the install reboots the computer, or the install runs in a minimized window. Note: The default flags are USERCONTEXT, USEUNCPATH, and ANY_PLATFORM.

    Bit flags Description
    DISABLED (bit 12) Program has been disabled.
    UNATTENDED (bit 13) User input is not required to run.
    USERCONTEXT (bit 14) User must be logged in for the program to run.
    ADMINRIGHTS (bit 15) Program must be run as the local Administrator account.
    EVERYUSER (bit 16) Program is offered to each new user that logs in. If this bit is not set, the program is offered only to the first user that logs in.

    This bit has meaning only when USERCONTEXT is set.
    NOUSERLOGGEDIN (bit 17) User must not be logged in when program runs.
    OKTOQUIT (bit 18) Program restarts the computer itself when it is finished running.
    OKTOREBOOT (bit 19) SMS restarts the computer when the program has finished running.
    USEUNCPATH (bit 20) Use a UNC path (no drive letter) to access the distribution point.
    PERSISTCONNECTION (bit 21) Persists the connection to the drive specified in the DriveLetter property. The USEUNCPATH bit flag must not be set.
    RUNMINIMIZED (bit 22) Run the program as a minimized window.
    RUNMAXIMIZED (bit 23) Run the program as a maximized window.
    HIDEWINDOW (bit 24) Hide the program's window.
    OKLOGOFF (bit 25) SMS logs the user off when the program has finished running.
    RUNACCOUNT (bit 26) Program runs using the SMS Windows NT Client Software Installation Account. This account is used for unattended installs and requires the UNATTENDED bit to be set. For details on this account, see the SMS Administrator's Guide. You can specify this account in the console or programmatically using the site control file.
    ANY_PLATFORM (bit 27) Program runs on any platform; ignore supported OS field.
    STILL_RUNNING (bit 28) Notifies the user if the program exceeds the Duration time by more than 15 minutes.
    SUPPORT_UNINSTALL (bit 29) Remove the program from the client when it is no longer advertised. If you set this bit, you must specify a value for RemovalKey.

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

    Required. Name that uniquely identifies the program.

  • Publisher
    Data type: string
    Access type: Read-only

    Manufacturer of the program.

  • Requirements
    Data type: string
    Access type: Read-only

    Description of any additional requirements of the program.

  • WorkingDirectory
    Data type: string
    Access type: Read-only

    Defines the location from which the program executes. This can be an absolute path on the client, or a path relative to the distribution point folder that contains the package.

Remarks

You cannot delete individual programs from the PDF store because SMS_PDF_Program is read-only. To delete a program you must delete the package template and then reload the package template without the program.

See Also

Creating a Package and Programs Using a PDF Template, Package Definition Files, SMS_PDF_Package, SMS_Program, Software Distribution Classes