Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Msvm_Keyboard class

Hyper-V

Represents a keyboard device. Keyboards are logical devices that are always present in a virtual system, and thus are not allocated through a resource pool. One instance is always present in a virtual computer system.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

class Msvm_Keyboard : CIM_UserDevice
{
  string   Caption = "Keyboard";
  string   Description = "Microsoft Virtual Keyboard";
  string   ElementName = "Keyboard";
  datetime InstallDate;
  string   Name = "Keyboard";
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "OK" };
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName = "GUID";
  string   CreationClassName = "Msvm_Keyboard";
  string   DeviceID = "Microsoft:GUID";
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = { 6 };
  uint64   MaxQuiesceTime;
  uint16   LocationIndicator = 4;
  boolean  IsLocked = False;
  string   Layout = "00000409";
  uint16   NumberOfFunctionKeys = 12;
  uint16   Password = 5;
};

Members

The Msvm_Keyboard class has these types of members:

Methods

The Msvm_Keyboard class has these methods.

MethodDescription
EnableDevice

This method is not supported.

IsKeyPressed

Determines whether the specified key is pressed.

OnlineDevice

This method is not supported.

PressKey

Sets the state of the specified key to "pressed".

QuiesceDevice

This method is not supported.

ReleaseKey

Clears the "pressed" state of the specified key.

RequestStateChange

This method is not supported.

Reset

This method is not supported.

RestoreProperties

This method is not supported.

SaveProperties

This method is not supported.

SetPowerState

This method is not supported.

TypeCtrlAltDel

Sends the CTRL+ALT+DEL key sequence.

TypeKey

Types the specified key. This is equivalent to calling PressKey followed by ReleaseKey.

TypeScancodes

Simulates a key sequence using scan codes.

Windows Server 2008:  The TypeScancodes method is not supported until Windows Server 2008 R2.

TypeText

Types the specified text string. This is equivalent to calling PressKey followed by ReleaseKey for each character in the string.

 

Properties

The Msvm_Keyboard class has these properties.

AdditionalAvailability
Data type: uint16 array
Access type: Read-only

Any additional availability and status of the device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the device. This property is inherited from CIM_LogicalDevice and it is always set to 6 (Not Applicable).

Availability
Data type: uint16
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is always set to "Keyboard".

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

The name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice and it is always set to "Msvm_Keyboard".

Description
Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Microsoft Virtual Keyboard".

DeviceID
Data type: string
Access type: Read-only

An address or other identifying information to uniquely name the logical device. This property is inherited from CIM_LogicalDevice and it is always set to "Microsoft:GUID".

ElementName
Data type: string
Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of the CIM_ManagedSystemElement class is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of CIM_LogicalDevice), the same information can be present in both the Name and ElementName properties. This property is inherited from CIM_ManagedElement and it is always set to "Keyboard".

EnabledDefault
Data type: uint16
Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 2 (Enabled).

EnabledState
Data type: uint16
Access type: Read-only

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 5 (Not Applicable).

ErrorCleared
Data type: boolean
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

ErrorDescription
Data type: string
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

HealthState
Data type: uint16
Access type: Read-only

The current health of the element. This property is inherited from CIM_ManagedSystemElement and it is always set to 5 (OK).

IdentifyingDescriptions
Data type: string array
Access type: Read-only

An array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo array. This property is inherited from CIM_LogicalDevice and it is always set to NULL.

InstallDate
Data type: datetime
Access type: Read-only

The date and time when the virtual system was created. This property is inherited from CIM_ManagedSystemElement.

IsLocked
Data type: boolean
Access type: Read-only

Indicates whether the device is locked, preventing user input or output. This property is inherited from CIM_UserDevice and it is set to False.

LastErrorCode
Data type: uint32
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

Layout
Data type: string
Access type: Read-only

A free-form string indicating the format and layout of the keyboard. This property is set to "00000409".

LocationIndicator
Data type: uint16
Access type: Read-only

The state of an indicator that is part of a device. This property is inherited from CIM_LogicalDevice and it is always set to 4 (Not Supported).

MaxQuiesceTime
Data type: uint64
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

Name
Data type: string
Access type: Read-only
Qualifiers: MaxLen (1024)

The label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement and it is always set to "Keyboard".

NumberOfFunctionKeys
Data type: uint16
Access type: Read-only

The number of function keys on the keyboard. This property is set to 12.

OperationalStatus
Data type: uint16 array
Access type: Read-only

The current status of the element. This property is inherited from CIM_ManagedSystemElement and it is always set to 2 (OK).

OtherEnabledState
Data type: string
Access type: Read-only

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property must be set to NULL when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement and it is always set to NULL.

OtherIdentifyingInfo
Data type: string array
Access type: Read-only

Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice and it is always set to NULL.

Password
Data type: uint16
Access type: Read-only

Indicates whether a hardware-level password is enabled at the keyboard, preventing local input. This property is set to 5 (Not Implemented).

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

PowerManagementSupported
Data type: boolean
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

PowerOnHours
Data type: uint64
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

RequestedState
Data type: uint16
Access type: Read-only

The last requested or desired state for the element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 12.

Status
Data type: string
Access type: Read-only

This property is inherited from CIM_ManagedSystemElement but it is not used.

StatusDescriptions
Data type: string array
Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and it is always set to "OK".

StatusInfo
Data type: uint16
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice and it is set to "Msvm_ComputerSystem".

SystemName
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

The scoping system's name. This value corresponds to the value of the Name property of the Msvm_ComputerSystem class for the scoping virtual system. This property is inherited from CIM_LogicalDevice and it is always set to "GUID".

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

The date and time when the enabled state of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. This property is inherited from CIM_EnabledLogicalElement and it is always set to NULL.

TotalPowerOnHours
Data type: uint64
Access type: Read-only

This property is inherited from CIM_LogicalDevice but it is not used.

Remarks

Access to the Msvm_Keyboard class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

End of client support

None supported

End of server support

Windows Server 2012

Namespace

\\.\Root\Virtualization

MOF

WindowsVirtualization.mof

See also

CIM_UserDevice
Input Classes

 

 

Community Additions

Show:
© 2014 Microsoft