Edit

Share via

Win32_TerminalService class

  • Article

The Win32_TerminalService WMI class is a subclass of the Win32_Service class. Win32_TerminalService represents the Element property of the Win32_TerminalServiceToSetting association.

The following syntax is simplified from MOF code and includes all defined and inherited properties, in alphabetical order.

Syntax

[dynamic, provider("Win32_WIN32_TERMINALSERVICE_Prov"), ClassContext("local|hkey_local_machine\\SYSTEM\\CurrentControlSet\\Control\\TerminalServer"), AMENDMENT]
class Win32_TerminalService : Win32_Service
{
  boolean  AcceptPause;
  boolean  AcceptStop;
  string   Caption;
  uint32   CheckPoint;
  string   CreationClassName;
  boolean  DelayedAutoStart;
  string   Description;
  boolean  DesktopInteract;
  string   DisplayName;
  string   ErrorControl;
  uint32   ExitCode;
  datetime InstallDate;
  string   Name;
  string   PathName;
  uint32   ProcessId;
  uint32   ServiceSpecificExitCode;
  string   ServiceType;
  boolean  Started;
  string   StartMode;
  string   StartName;
  string   State;
  string   Status;
  string   SystemCreationClassName;
  string   SystemName;
  uint32   TagId;
  uint32   WaitHint;
  uint32   DisconnectedSessions;
  uint32   TotalSessions;
};

Members

The Win32_TerminalService class has these types of members:

Methods

The Win32_TerminalService class has these methods.

Method Description
Change Modifies a service.
ChangeStartMode Modifies the start mode of a service.
Create Creates a new service.
Delete Deletes an existing service.
GetSecurityDescriptor Returns the security descriptor that controls access to the service.
InterrogateService Requests that a service update its state to the service manager.
PauseService Attempts to place a service in the paused state.
ResumeService Attempts to place a service in the resumed state.
SetSecurityDescriptor Writes an updated version of the security descriptor that controls access to the service.
StartService Attempts to place a service into the startup state.
StopService Places a service in the stopped state.
UserControlService Attempts to send a user-defined control code to a service.

Properties

The Win32_TerminalService class has these properties.

AcceptPause

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_STATUS|dwControlsAccepted|SERVICE_ACCEPT_PAUSE_CONTINUE"), DisplayName ("Service Accepts Pause")

Indicates whether the service can be paused.

This property is inherited from Win32_BaseService.

AcceptStop

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_STATUS|dwControlsAccepted|SERVICE_ACCEPT_STOP"), DisplayName ("Service Accepts Stop")

Indicates whether the service can be stopped.

This property is inherited from Win32_BaseService.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

Short description of the service a one-line string.

This property is inherited from CIM_ManagedSystemElement.

CheckPoint

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_STATUS|dwCheckPoint"), DisplayName ("Check Point Count")

Value that the service increments periodically to report its progress during a long start, stop, pause, or continue operation. For example, the service increments this value as it completes each step of its initialization when it is starting up. The user interface program that invokes the operation on the service uses this value to track the progress of the service during a lengthy operation. This value is not valid and should be zero when the service does not have a start, stop, pause, or continue operation pending.

This property is inherited from Win32_Service.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: CIM_Key, DisplayName ("Class Name")

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.

This property is inherited from CIM_Service.

DelayedAutoStart

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_DELAYED_AUTO_START_INFO|fDelayedAutostart"), DisplayName ("Delayed Auto-Start")

If True, the service is started after other auto-start services are started plus a short delay.

Windows Server 2012 R2, Windows 8.1, Windows Server 2012, Windows 8, Windows Server 2008 R2, Windows 7, Windows Server 2008 and Windows Vista: This property is not supported before Windows Server 2016 and Windows 10.

This property is inherited from Win32_Service.

Description

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Description")

Description of the object.

This property is inherited from CIM_ManagedSystemElement.

DesktopInteract

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|QUERY_SERVICE_CONFIG|dwServiceType|SERVICE_INTERACTIVE_PROCESS"), DisplayName ("Interacts With Desktop")

Indicates whether the service can create or communicate with windows on the desktop, and thus interact in some way with a user. Interactive services must run under the Local System account. Most services are not interactive; that is, they do not communicate with the user in any way.

This property is inherited from Win32_BaseService.

DisconnectedSessions

Data type: uint32

Access type: Read-only

The number of disconnected sessions on the current server. These sessions may still be actively consuming server resources, however they currently have no network connection with a client.

DisplayName

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|QUERY_SERVICE_CONFIG|lpDisplayName"), DisplayName ("Display Name")

Name of the service as viewed in the Services snap-in. This string has a maximum length of 256 characters. Note that the display name and the service name (which is stored in the registry) are not always the same. For example, the DHCP Client service has the service name Dhcp but the display name DHCP Client. The name is case-preserved in the Service Control Manager. However, DisplayName comparisons are always case-insensitive.

Constraint: Accepts the same value as the Name property.

Example: "Atdisk"

This property is inherited from Win32_BaseService.

ErrorControl

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|QUERY_SERVICE_CONFIG|dwErrorControl"), DisplayName ("Severity Of Startup Failure")

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.

Ignore ("Ignore")

User is not notified.

Normal ("Normal")

User is notified. Usually this will be a message box display notifying the user of the problem.

Severe ("Severe")

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

Critical ("Critical")

System attempts to restart with a good configuration. If the service fails to start a second time, startup fails.

Unknown ("Unknown")

Severity of the error is unknown.

This property is inherited from Win32_BaseService.

ExitCode

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_STATUS|dwWin32ExitCode"), DisplayName ("Exit Code")

Windows error code that defines errors 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.

This property is inherited from Win32_BaseService.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Date object is installed. This property does not require a value to indicate that the object is installed.

This property is inherited from CIM_ManagedSystemElement.

Name

Data type: string

Access type: Read-only

Qualifiers: Key

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

This property is inherited from CIM_ManagedSystemElement.

PathName

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|QUERY_SERVICE_CONFIG|lpBinaryPathName"), DisplayName ("File Path Name")

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

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

This property is inherited from Win32_BaseService.

ProcessId

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_STATUS_PROCESS|dwProcessId"), DisplayName ("Process Id")

Process identifier of the service.

Example: 324

This property is inherited from Win32_Service.

ServiceSpecificExitCode

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_STATUS|dwServiceSpecificExitCode"), DisplayName ("Server Specific Exit Code")

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).

This property is inherited from Win32_BaseService.

ServiceType

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|QUERY_SERVICE_CONFIG|dwServiceType"), DisplayName ("Service Type")

Type of service provided to calling processes.

The values are:

Kernel Driver ("Kernel Driver")

File System Driver ("File System Driver")

Adapter ("Adapter")

Recognizer Driver ("Recognizer Driver")

Own Process ("Own Process")

Share Process ("Share Process")

Interactive Process ("Interactive Process")

This property is inherited from Win32_BaseService.

Started

Data type: boolean

Access type: Read-only

Qualifiers: DisplayName ("Started")

Indicates whether or not the service is started.

This property is inherited from CIM_Service.

StartMode

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Start Mode")

Start mode of the Windows base service.

Boot ("Boot")

Device driver started by the operating system loader (valid only for driver services).

System ("System")

Device driver started by the operating system initialization process. This value is valid only for driver services.

Auto ("Auto")

Service to be started automatically by the service control manager during system startup. Auto services are started even if a user does not log on.

Manual ("Manual")

Service to be started by the Service Control Manager when a process calls the StartService method. These services do not start unless a user logs on and starts them.

Disabled ("Disabled")

Service that cannot be started until its StartMode is changed to either Auto or Manual.

This property is inherited from CIM_Service.

StartName

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|QUERY_SERVICE_CONFIG|lpServiceStartName"), DisplayName ("Starting Account Name")

Account name under which a service runs. Depending on the service type, the account name may be in the form of "DomainName\Username" or UPN format ("Username@DomainName"). The service process is logged by using one of these two forms when it runs. If the account belongs to the built-in domain, then ".\Username" can be specified. For kernel or system-level drivers, StartName contains the driver object name (that is, "\FileSystem\Rdr" or "\Driver\Xns") which the 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.

Example: "DWDOM\Admin"

This property is inherited from Win32_BaseService.

State

Data type: string

Access type: Read/write

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_STATUS|dwCurrentState "), DisplayName ("State")

Current state of the base service.

The values are:

Stopped ("Stopped")

Start Pending ("Start Pending")

Stop Pending ("Stop Pending")

Running ("Running")

Continue Pending ("Continue Pending")

Pause Pending ("Pause Pending")

Paused ("Paused")

Unknown ("Unknown")

Windows Server 2008 and Windows Vista: This property is read-only before Windows 7 and Windows Server 2008 R2.

This property is inherited from Win32_BaseService.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10), DisplayName ("Status")

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 ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Propagated ("CIM_System.CreationClassName"), CIM_Key, DisplayName ("System Class Name")

Type name of the system that hosts this service.

This property is inherited from CIM_Service.

SystemName

Data type: string

Access type: Read-only

Qualifiers: Propagated ("CIM_System.Name"), CIM_Key, DisplayName ("System Name")

Name of the system that hosts this service.

This property is inherited from CIM_Service.

TagId

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|QUERY_SERVICE_CONFIG|dwTagId"), DisplayName ("Tag Id")

Unique tag value for this service in the group. A value of 0 (zero) indicates that the service does not have a tag. A tag can be used to order 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.

This property is inherited from Win32_BaseService.

TotalSessions

Data type: uint32

Access type: Read-only

The total number of sessions on the current server. This includes both connected and disconnected sessions.

WaitHint

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("Win32API|Service Structures|SERVICE_STATUS|dwWaitHint"), DisplayName ("Estimated Wait Time")

Estimated time required, in milliseconds, for a pending start, stop, pause, or continue operation. After the specified time has elapsed, the service makes its next call to the SetServiceStatus method with either an incremented CheckPoint value or a change in CurrentState. If the amount of time specified by WaitHint passes, and CheckPoint has not been incremented, or CurrentState has not changed, the service control manager or service control program assumes that an error has occurred.

This property is inherited from Win32_Service.

Remarks

Since the Win32_TerminalService class is a subclass of the Win32_Service class, the class inherits all properties and methods of Win32_Service.

Win32_TerminalServiceSetting is associated to Win32_TerminalService as the Setting property of the Win32_TerminalServiceToSetting association.

Win32_TSSessionDirectory is associated to Win32_TerminalService as the Setting property of the Win32_TSSessionDirectorySetting association.

Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Microsoft Windows Software Development Kit (SDK). They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).

Requirements

Requirement Value
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
Namespace
 Root\CIMv2
MOF
TSCfgWmi.mof
DLL
TSCfgWmi.dll

See also

Win32_Service

Win32_TerminalServiceToSetting

Win32_TSSessionDirectory

Win32_BaseService

CIM_Service