RequestStateChange method of the CIM_ConcreteJob class
Requests that the state of the job be changed to the value specified in the RequestedState parameter. Invoking the RequestStateChange method multiple times could 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.
Important The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.
Syntax
uint32 RequestStateChange(
[in] uint16 RequestedState,
[in] datetime TimeoutPeriod
);
Parameters
RequestedState [in]
The new state of a job.Value Meaning 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 7..32767 Reserved.
Vendor Reserved 32768..65535 Reserved.
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 TimeoutPeriod. A value of 0 or a null parameter 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 'Use Of Timeout Parameter Not Supported' 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)
Cannot complete within Timeout Period (3)
Failed (4)
Invalid Parameter (5)
In Use (6)
DMTF Reserved (..)
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
Namespace |
Root\CIMV2 |