Win32_SystemDriver Class
Win32_SystemDriver Class

The Win32_SystemDriverWMI class represents the system driver for a base service.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

class Win32_SystemDriver : Win32_BaseService
{
  boolean  AcceptPause;
  boolean  AcceptStop;
  string   Caption;
  string   CreationClassName;
  string   Description;
  boolean  DesktopInteract;
  string   DisplayName;
  string   ErrorControl;
  uint32   ExitCode;
  datetime InstallDate;
  string   Name;
  string   PathName;
  uint32   ServiceSpecificExitCode;
  string   ServiceType;
  boolean  Started;
  string   StartMode;
  string   StartName;
  string   State;
  string   Status;
  string   SystemCreationClassName;
  string   SystemName;
  uint32   TagId;
};

Members

The Win32_SystemDriver class defines the following members:

Methods

The Win32_SystemDriver class defines the following methods.

MethodDescription
StartService

Class method that attempts to place the service into its startup state.

StopService

Class method that places the service in the stopped state.

PauseService

Class method that attempts to place the service in the paused state.

ResumeService

Class method that attempts to place the service in the resumed state.

InterrogateService

Class method that requests that the service update its state to the service manager.

UserControlService

Class method that attempts to send a user-defined control code to a service.

Create

Class method that creates a new service.

Change

Class method that modifies a service.

ChangeStartMode

Class method that modifies the start mode of a service.

Delete

Class method that deletes an existing service.

 

Properties

The Win32_SystemDriver class defines the following properties.

AcceptPause
Data type: boolean
Access type: Read-only

Service can be paused.

AcceptStop
Data type: boolean
Access type: Read-only

Service can be stopped.

Caption
Data type: string
Access type: Read-only

Short description (one-line string) of the object.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Name of the first concrete class to appear in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, this property allows all instances of this class and its subclasses to be uniquely identified.

Description
Data type: string
Access type: Read-only

Description of the object.

DesktopInteract
Data type: boolean
Access type: Read-only

This service can create or communicate with windows on the desktop.

DisplayName
Data type: string
Access type: Read-only

Display name of the service. This string has a maximum length of 256 characters. The name is case-preserved in the Service Control Manager. DisplayName comparisons are always case-insensitive.

Constraints: Accepts the same value as the Name property.

Example: "Atdisk"

ErrorControl
Data type: string
Access type: Read-only

Severity of the error if this service fails to start during startup. This value indicates the action taken by the startup program if failure occurs. All errors are logged by the computer system.

ValueMeaning
"Ignore"

User is not notified.

"Normal"

User is notified.

"Severe"

System is restarted with the last-known-good configuration.

"Critical"

System attempts to restart with a good configuration.

"Unknown"

Cause of the failure is unknown.

 

ExitCode
Data type: uint32
Access type: Read-only

Windows error code defining any problems encountered in starting or stopping the service. This property is set to ERROR_SERVICE_SPECIFIC_ERROR (1066) when the error is unique to the service represented by this class, and information about the error is available in the ServiceSpecificExitCode property. The service sets this value to NO_ERROR when running, and again upon normal termination.

InstallDate
Data type: datetime
Access type: Read-only

Object was installed. This property does not need a value to indicate that the object is installed.

Name
Data type: string
Access type: Read-only

Unique identifier for the service which provides an indication of the functionality that is managed. This functionality is described in more detail in the object Description property.

PathName
Data type: string
Access type: Read-only

Fully-qualified path to the service binary file that implements the service.

Example: "\SystemRoot\System32\drivers\afd.sys"

ServiceSpecificExitCode
Data type: uint32
Access type: Read-only

Service-specific error code for errors that occur while the service is either starting or stopping. The exit codes are defined by the service represented by this class. This value is only set when the ExitCode property value is ERROR_SERVICE_SPECIFIC_ERROR (1066).

ServiceType
Data type: string
Access type: Read-only

Type of service provided to calling processes.

The values are:

"Kernel Driver"

"File System Driver"

"Adapter"

"Recognizer Driver"

"Own Process"

"Share Process"

"Interactive Process"

Started
Data type: boolean
Access type: Read-only

Service has been started.

StartMode
Data type: string
Access type: Read-only

Severity of the error if this service fails to start during startup. The value indicates the action taken by the startup program if failure occurs. All errors are logged by the computer system.

ValueMeaning
"Ignore"

User is not notified.

"Normal"

User is notified.

"Severe"

System is restarted with the last-known-good configuration.

"Critical"

System attempts to restart with a good configuration.

"Unknown"

Cause of the failure is unknown.

 

StartName
Data type: string
Access type: Read-only

Account name under which the service runs. Depending on the service type, the account name may be in the form of DomainName\Username. The service process will be logged using one of these two forms when it runs. If the account belongs to the built-in domain, .\Username can be specified. If NULL is specified, the service will be logged on as the LocalSystem account. For kernel or system-level drivers, StartName contains the driver object name (that is, \FileSystem\Rdr or \Driver\Xns) which the input and output (I/O) system uses to load the device driver. Additionally, if NULL is specified, the driver runs with a default object name created by the I/O system based on the service name.

Windows XP:  You can use User Principal Name (UPN) format (Username@DomainName) to specify the StartName.

Example: "DWDOM\Admin"

State
Data type: string
Access type: Read/write

Current state of the base service.

The values are:

"Stopped"

"Start Pending"

"Stop Pending"

"Running"

"Continue Pending"

"Pause Pending"

"Paused"

"Unknown"

Status
Data type: string
Access type: Read-only

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, yet the managed element is neither "OK" nor in one of the other states.

The values are:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
SystemCreationClassName
Data type: string
Access type: Read-only

Type name of the system that hosts this service.

SystemName
Data type: string
Access type: Read-only

Name of the system that hosts this service.

TagId
Data type: uint32
Access type: Read-only

Unique tag value for this service in the group. A value of 0 (zero) indicates that the service has not been assigned a tag. A tag can be used for ordering service startup within a load order group by specifying a tag order vector in the registry located at:

HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\GroupOrderList.

Tags are only evaluated for Kernel Driver and File System Driver start-type services that have Boot or System start modes.

Remarks

The Win32_SystemDriver class is derived from Win32_BaseService.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported clientWindows 2000 Professional
Minimum supported serverWindows 2000 Server
MOFCimwin32.mof
DLLCimwin32.dll
Namespace\root\cimv2

See Also

Operating System Classes

 

 

Send comments about this topic to Microsoft

Build date: 1/8/2010

Build type: MSDN

© 2010 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View