RequestStateChange method of the Msvm_ConcreteJob class

Article
01/07/2021

Requests that the state of the job be changed to the specified state. Invoking the RequestStateChange method multiple times can result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully. Any other return code indicates an error condition.

Syntax

uint32 RequestStateChange(
  [in] uint16   RequestedState,
  [in] datetime TimeoutPeriod
);

Parameters

RequestedState [in]

Type: uint16

The new state of a job.

Start (2)

Changes the state to "Running".

Suspend (3)

Stops the job temporarily. The intention is to subsequently restart the job with "Start". It might be possible to enter the "Service" state while suspended. (This is job specific.)

Terminate (4)

Stops the job cleanly, saving data, preserving the state, and shutting down all underlying processes in an orderly manner.

Kill (5)

Terminates the job immediately with no requirement to save data or preserve the state.

Service (6)

Puts the job into a vendor-specific service state. It might be possible to restart the job.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

TimeoutPeriod [in]

Type: datetime

A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the timeout period. A value of 0 or Null indicates that the client has no time requirements for the transition. If this property does not contain 0 or Null and the implementation does not support this parameter, a return code of 4098 (Use Of Timeout Parameter Not Supported) must be returned.

Return value

Type: uint32

This method returns one of the following values.

Completed with No Error (0)
Not Supported (1)
Unknown/Unspecified Error (2)
Cannot complete within Timeout Period (3)
Failed (4)
Invalid Parameter (5)
In Use (6)
DMTF Reserved (7 4095)
Method Parameters Checked - Transition Started (4096)
Invalid State Transition (4097)
Use of Timeout Parameter Not Supported (4098)
Busy (4099)
Method Reserved (4100 32767)
Vendor Specific (32768 65535)

Remarks

Access to the Msvm_ConcreteJob class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe