RequestStateChange method of the Msvm_CollectionReferencePointExportJob class

Requests a state change.

Syntax

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

Parameters

RequestedState [in]

RequestStateChange changes the state of a job. The possible values are as follows:

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, saves data, preserves the state, and shuts 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 (7..32767)

Vendor Reserved (32768..65535)

TimeoutPeriod [in]

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

Returns 0 on success; otherwise, returns one of the following errors.

(0)

(32768)

(32769)

(32770)

(32771)

(32772)

(32773)

(32774)

(32775)

(32776)

(32777)

(32778)

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1703 [desktop apps only]
Minimum supported server	Windows Server 2016
Namespace	Root\virtualization\v2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

See also

Msvm_CollectionReferencePointExportJob