RequestStateChange method of the Msvm_Keyboard class

  • Article

Requests that the state of the element be changed.

Syntax

uint32 RequestStateChange(
  [in]  uint16              RequestedState,
  [out] CIM_ConcreteJob REF Job,
  [in]  datetime            TimeoutPeriod
);

Parameters

RequestedState [in]

The new state requested for the element. This information will be placed into the RequestedState property of the instance if the return code is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). For detailed explanations of the RequestedState values, see the description of the EnabledState and RequestedState properties.

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]

A reference to the job. This parameter can be Null if the task is completed.

TimeoutPeriod [in]

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 this time-out 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") is returned.

Return value

Completed with No Error (0)

Not supported (1)

Unknown or Unspecified Error (2)

Cannot complete within Timeout Period (3)

Failed (4)

Invalid Parameter (5)

In Use (6)

DMTF Reserved (..)

Method Parameters Checked - Job Started (4096)

Invalid State Transition (4097)

Use of Timeout Parameter Not Supported (4098)

Busy (4099)

Method Reserved (4100..32767)

Vendor Specific (32768..65535)

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
WindowsVirtualization.V2.mof
DLL
Vmms.exe

See also

Msvm_Keyboard