RequestStateChange method of the Msvm_SyntheticMouse class
Requests a state change.
Syntax
uint32 RequestStateChange(
[in] uint16 RequestedState,
[out] CIM_ConcreteJob REF Job,
[in] datetime TimeoutPeriod
);
Parameters
-
RequestedState [in]
-
The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
-
Enabled (2)
-
Disabled (3)
-
Shut Down (4)
-
Offline (6)
-
Test (7)
-
Defer (8)
-
Quiesce (9)
-
Reboot (10)
-
Reset (11)
-
DMTF Reserved (..)
-
Vendor Reserved (32768..65535)
Job [out]
May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.
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' shall be returned.
Return value
This method returns one of the following values:
-
Completed with No Error (0)
-
Not supported (1)
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 8.1 |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\virtualization\v2 |
| MOF |
|
| DLL |
|