ChangeStartMode method of the Win32_Service class (Remote Desktop Services)

Article
12/11/2020

The ChangeStartMode WMI class method modifies the start mode of a Win32_TerminalService.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax

uint32 ChangeStartMode(
  [in] string StartMode
);

Parameters

StartMode [in]: Start mode of the Windows base service.
Boot: Device driver started by the operating system loader. This value is valid only for driver services.
System: Device driver started by the operating system initialization process. This value is valid only for driver services.
Automatic: Service to be started automatically by the Service Control Manager during system startup.
Manual: Service to be started by the Service Control Manager when a process calls the StartService method.
Disabled: Service that can no longer be started.

Return value

Returns one of the values listed in the following list or any other value to indicate an error. For additional error codes, see WMI Error Constants or WbemErrorEnum. For general HRESULT values, see System Error Codes.

0: The request was accepted.
1: The request is not supported.
2: The user did not have the necessary access.
3: The service cannot be stopped because other services that are running are dependent on it.
4: The requested control code is not valid, or it is unacceptable to the service.
5: The requested control code cannot be sent to the service because the state of the service (Win32_BaseService.State property) is equal to 0, 1, or 2.
6: The service has not been started.
7: The service did not respond to the start request in a timely fashion.
8: Unknown failure when starting the service.
9: The directory path to the service executable file was not found.
10: The service is already running.
11: The database to add a new service is locked.
12: A dependency this service relies on has been removed from the system.
13: The service failed to find the service needed from a dependent service.
14: The service has been disabled from the system.
15: The service does not have the correct authentication to run on the system.
16: This service is being removed from the system.
17: The service has no execution thread.
18: The service has circular dependencies when it starts.
19: A service is running under the same name.
20: The service name has invalid characters.
21: Invalid parameters have been passed to the service.
22: The account under which this service runs is either invalid or lacks the permissions to run the service.
23: The service exists in the database of services available from the system.
24: The service is currently paused in the system.

Examples

The following Change StartMode of a Service PowerShell sample, pulled from TechNet Gallery, changes the start mode of a service.

$wmi = get-wmiobject -class win32_service -namespace root\cimv2 -computername lisbon | 
where-object { $_.name -eq 'bits' } 
 
$rtn = $wmi.changestartmode("manual") 
if($rtn.returnvalue -eq 0) { "success" } 
ELSE 
  { " $($rtn.returnvalue) was reported" }

Requirements

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

Share via