Msvm_CopyFileToGuestJob::RequestStateChange method
Changes the state of the job.
Syntax
uint32 RequestStateChange(
[in] uint16 RequestedState,
[in] datetime TimeoutPeriod
);
Parameters
-
RequestedState [in]
-
The new state. These are the possible values:
-
Start (2)
-
Changes the state to 'Running'.
-
Suspend (3)
-
Stops the job temporarily. The client can then subsequently restart the job with 'Start'. The client can possibly 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. The client can possibly 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
This method returns one of the following values.
| Return code/value | Description |
|---|---|
|
Success. |
|
|
|
|
|
Access denied. |
|
|
|
|
|
|
|
|
|
|
|
The value specified in the RequestedState parameter is not supported. |
|
|
|
|
|
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 8.1 [desktop apps only] |
| Minimum supported server |
Windows Server 2012 R2 [desktop apps only] |
| Namespace |
\\Root\Virtualization\V2 |
| MOF |
|
| DLL |
|