Msvm_SyntheticMouse class

Artículo
05/31/2018

Represents a synthetic mouse device.

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_SyntheticMouse : CIM_PointingDevice
{
  string   Caption = "Mouse";
  string   Description = "Microsoft Synthetic Mouse";
  datetime InstallDate;
  string   Name = "Mouse";
  uint16   OperationalStatus[] = 2;
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName = "GUID";
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  uint16   AdditionalAvailability[] = 6;
  uint64   MaxQuiesceTime;
  uint16   LocationIndicator = 4;
  boolean  IsLocked = False;
  uint16   PointingType = 3;
  uint8    NumberOfButtons = 5;
  uint32   Resolution;
  string   ElementName = "Mouse";
  string   StatusDescriptions[] = "OK";
  string   CreationClassName = "Msvm_SyntheticMouse";
  string   DeviceID = "Microsoft:GUID";
  string   OtherIdentifyingInfo[];
  string   IdentifyingDescriptions[];
  uint16   Handedness = 2;
  boolean  AbsoluteCoordinates = True;
  sint32   HorizontalPosition;
  sint32   VerticalPosition;
  sint32   ScrollPosition;
};

Members

The Msvm_SyntheticMouse class has these types of members:

Methods
Properties

Methods

The Msvm_SyntheticMouse class has these methods.

Method	Description
ClickButton	Performs a mouse click of the specified button. This is equivalent to calling SetButtonState twice, first to press the button, and again to release it.
EnableDevice	This method is not supported.
GetButtonState	Gets the current button state (up or down) of a specified button.
OnlineDevice	This method is not supported.
QuiesceDevice	This method is not supported.
RequestStateChange	Requests that the state of the element be changed to the value specified in the RequestedState parameter. This method is inherited from CIM_EnabledLogicalElement and returns 1 (Not Supported).
Reset	This method is not supported.
RestoreProperties	This method is not supported.
SaveProperties	This method is not supported.
SetAbsolutePosition	Sets the horizontal and vertical position of the mouse cursor.
SetButtonState	Sets whether the specified mouse button is currently pressed.
SetPowerState	This method is not supported.
SetScrollPosition	Changes the z-coordinate of the wheel control of the mouse. Values written to this property are always relative coordinate offsets.

Properties

The Msvm_SyntheticMouse 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. This property is set to True.

AdditionalAvailability

Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

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
Qualifiers: Deprecated ("CIM_AssociatedPowerManagementService.PowerState", "CIM_ManagedSystemElement.OperationalStatus", "CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

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 "Mouse".

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, 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_SyntheticMouse".

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 Synthetic Mouse".

DeviceID

Data type: string
Access type: Read-only
Qualifiers: Key, 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 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 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/write

An administrator's default or startup configuration for the EnabledState 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
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement and it is set to 2 (Enabled) if the guest VM supports a synthetic mouse and 3 (Disabled) if it does not (for example, DOS).

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Disabled (3)

ErrorCleared

Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

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

ErrorDescription

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

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 and it is always set to 2 (Right 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).

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

HorizontalPosition

Data type: sint32
Access type: Read-only

The absolute x-coordinate of the pointing device.

IdentifyingDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

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
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The date and time at which 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
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

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

LocationIndicator

Data type: uint16
Access type: Read/write
Qualifiers: Experimental, ModelCorrespondence ("CIM_AlarmDevice.AlarmState", "CIM_AlarmDevice.AudioIndicatorIsDisabled", "CIM_AlarmDevice.VisualIndicatorIsDisabled", "CIM_AlarmDevice.MotionIndicatorIsDisabled")

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
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

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 "Mouse".

NumberOfButtons

Data type: uint8
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Pointing Device|003.4")

The number of buttons on the pointing device. This property is inherited from CIM_PointingDevice and it is always set to 5.

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

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

OK (2)

Indicates full functionality without errors.

OtherEnabledState

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

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.

PointingType

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Pointing Device|003.1")

The type of pointing device. This property is inherited from CIM_PointingDevice and it is always set to 3 (Mouse).

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

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

PowerManagementSupported

Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

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

PowerOnHours

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.PowerOnHours"), Units ("Hours"), Counter

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

RequestedState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

Resolution

Data type: uint32
Access type: Read-only
Qualifiers: Units ("Counts per Inch")

The resolution of the primary video surface. This property is inherited from CIM_PointingDevice.

ScrollPosition

Data type: sint32
Access type: Read-only
Qualifiers: Units ("Mickeys")

The z-coordinate position of the mouse device.

Status

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

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

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

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
Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

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

SystemCreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The creation class name of the scoping system. This property is inherited from CIM_LogicalDevice and it is always set to "Msvm_ComputerSystem".

SystemName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The name of the scoping system. 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 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 and it is always set to NULL.

TotalPowerOnHours

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter

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

VerticalPosition

Data type: sint32
Access type: Read-only

The absolute y-coordinate of the pointing device.

Remarks

Access to the Msvm_SyntheticMouse 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 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof

Compartir a través de

Msvm_SyntheticMouse class

Syntax

Members

Methods

Properties

Remarks

Requirements

See also

Recursos adicionales