Msvm_Ps2Mouse class

Article
01/07/2021

Represents a PS2 mouse device. Instances of this class are logical devices that are always present in a virtual machine, and thus are not allocated through a resource pool. One instance is always present in a virtual machine.

Note

This class is not available to generation 2 virtual machines.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_Ps2Mouse : CIM_PointingDevice
{
  string   InstanceID;
  string   Caption = "Mouse";
  string   Description = "Microsoft Emulated Mouse";
  string   ElementName = "Mouse";
  datetime InstallDate;
  string   Name = "Mouse";
  uint16   OperationalStatus[] = 2;
  string   StatusDescriptions[] = "OK";
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_PS2Mouse";
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability = 6;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = 6;
  uint64   MaxQuiesceTime;
  boolean  IsLocked = False;
  uint16   PointingType = 3;
  uint8    NumberOfButtons = 5;
  uint16   Handedness = 2;
  uint32   Resolution;
  boolean  AbsoluteCoordinates = False;
};

Members

The Msvm_Ps2Mouse class has these types of members:

Methods
Properties

Methods

The Msvm_Ps2Mouse class has these methods.

Method	Description
ClickButton	Simulates a button click, a down-up sequence, on the specified device button.
EnableDevice	This method is not supported.
GetButtonState	Retrieves the current state of the specified device button.
OnlineDevice	This method is not supported.
QuiesceDevice	This method is not supported.
RequestStateChange	Requests a state change.
Reset	Resets the device.
RestoreProperties	This method is not supported.
SaveProperties	This method is not supported.
SetButtonState	Sets the current state of the specified device button.
SetPowerState	This method is not supported.
SetRelativePosition	Offsets the position of the mouse pointer by the specified horizontal and vertical deltas.
SetScrollPosition	Adjusts the z-coordinate of the wheel control of the pointing device.

Properties

The Msvm_Ps2Mouse class has these properties.

AbsoluteCoordinates

Data type: boolean
Access type: Read-only

Indicates whether the device operates on absolute coordinates. If not set, the device's coordinates are relative.

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.

Value	Meaning
6	Not Applicable

Availability

Data type: uint16
Access type: Read-only

The primary availability and status of the device. This property is inherited from CIM_LogicalDevice.

Value	Meaning
6	Not Applicable

AvailableRequestedStates

Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

Caption

Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement.

CommunicationStatus

Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Communication OK (2)
Lost Communication (3)
No Contact (4)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

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.

Description

Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

DetailedStatus

Data type: uint16
Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)
No Additional Information (1)
Stressed (2)
Predictive Failure (3)
Non-Recoverable Error (4)
Supporting Entity in Error (5)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

DeviceID

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

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 display name for the object. This property allows each instance to define a display name in addition to its key properties, identity data, and description information. The Name property of the CIM_ManagedSystemElement class is also defined as a display name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a display 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 "Mouse".

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.

EnabledState

Data type: uint16
Access type: Read-only

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement.

ErrorCleared

Data type: boolean
Access type: Read-only

Indicates whether the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice, but it is not used.

ErrorDescription

Data type: string
Access type: Read-only

A string that provides more information about the error recorded in LastErrorCode and information about any corrective actions that can be taken. This property is inherited from CIM_LogicalDevice, but it is not used.

Handedness

Data type: uint16
Access type: Read-only

The configuration of the pointing device for right-hand or left-hand operation. This property is inherited from CIM_PointingDevice.

Value	Meaning
0	Unknown
1	Not applicable.
2	Right handed operation.
3	Left handed operation.

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.

InstallDate

Data type: datetime
Access type: Read-only

The date and time at which the virtual machine was created. This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

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.

LastErrorCode

Data type: uint32
Access type: Read-only

The last error code reported by the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.

MaxQuiesceTime

Data type: uint64
Access type: Read-only

This property has been deprecated. This property is inherited from CIM_LogicalDevice.

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.

NumberOfButtons

Data type: uint8
Access type: Read-only

The number of buttons on the pointing device. This property is inherited from CIM_PointingDevice.

OperatingStatus

Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Servicing (2)
Starting (3)
Stopping (4)
Stopped (5)
Aborted (6)
Dormant (7)
Completed (8)
Migrating (9)
Emigrating (10)
Immigrating (11)
Snapshotting (12)
Shutting Down (13)
In Test (14)
Transitioning (15)
In Service (16)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

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

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.

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.

PointingType

Data type: uint16
Access type: Read-only

The type of the pointing device. This property is inherited from CIM_PointingDevice.

Value	Meaning
3	Mouse

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only

The power management capabilities of the device. This property is inherited from CIM_LogicalDevice, but it is not used.

PowerManagementSupported

Data type: boolean
Access type: Read-only

Indicates whether the device can be power managed. This property is inherited from CIM_LogicalDevice, but it is not used.

PowerOnHours

Data type: uint64
Access type: Read-only

The number of consecutive hours that this device has been powered on since its last power cycle. This property is inherited from CIM_LogicalDevice, but it is not used.

PrimaryStatus

Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

RequestedState

Data type: uint16
Access type: Read-only

The last requested or desired state for the element. This property is inherited from CIM_EnabledLogicalElement.

Value	Meaning
12	Not applicable.

Resolution

Data type: uint32
Access type: Read-only

The tracking resolution of the pointing device, in counts per inch. This property is inherited from CIM_PointingDevice.

Status

Data type: string
Access type: Read-only

The current status of the object. 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

The current state of the logical device. 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.

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 machine. This property is inherited from CIM_LogicalDevice.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date or 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.

TotalPowerOnHours

Data type: uint64
Access type: Read-only

The total number of hours that this device has been powered. This property is inherited from CIM_LogicalDevice, but it is not used.

TransitioningToState

Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

Remarks

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

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe