RequestStateChange method of the CIM_ConcreteJob class

Requests that the state of the job be changed to the specified value. The allowed transitions are job specific and vendor specific. To invoke this method multiple times could cause earlier requests to be overwritten or to be lost.

Syntax

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

Parameters

RequestedState [in]

Specifies the state to which the job should be changed.

Start (2)

Changes the state to Running.

Suspend (3)

Stops the job temporarily. You can restart the job and possibly enter the Service state while the job is suspended. This value is job-specific.

Terminate (4)

Stops the job cleanly, save data, preserve the state, and shut down all underlying processes in an orderly manner.

Kill (5)

Stops 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 from this state.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

TimeoutPeriod [in]

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 TimeoutPeriod parameter. A value of 0 or a null parameter indicates that the client has no time requirements for the transition.

Note

If the implementation does not support this parameter and this property does not contain 0 or null, the Use Of Timeout Parameter Not Supported value must be returned.

Return value

This method returns one of the following values.

Completed with No Error (0)

Not Supported (1)

Unknown/Unspecified Error (2)

Can NOT 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)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\Microsoft\Windows\StorageReplica
MOF	WVRCimProv.Mof
DLL	WvrCimProv.dll

See also

CIM_ConcreteJob