Msvm_Ps2Mouse, ROOT\virtualization\v2\ms_409

Class | Methods (5) | Properties (1) | Qualifiers (3) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Represents a PS2 mouse device. Instances of this class 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.

Msvm_Ps2Mouse methods

Msvm_Ps2Mouse has 5 methods (5 Local)

NameOriginReturn
ClickButtonMsvm_Ps2Mouseuint32 {'out':True}
GetButtonStateMsvm_Ps2Mouseuint32 {'out':True}
SetButtonStateMsvm_Ps2Mouseuint32 {'out':True}
SetRelativePositionMsvm_Ps2Mouseuint32 {'out':True}
SetScrollPositionMsvm_Ps2Mouseuint32 {'out':True}

Msvm_Ps2Mouse properties

Msvm_Ps2Mouse has 1 properties (1 Local)

NameOriginCIMType
AbsoluteCoordinatesMsvm_Ps2Mouse11 [boolean]

Detailed description of Msvm_Ps2Mouse methods

Local methods (5) of Msvm_Ps2Mouse class

ClickButton method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
buttonIndexuint320-{'Description':'The 1-based index of the button.','In':True}
Description'Simulates a button click, a down-up sequence, on the specified device button.
Return value: A return value of zero indicates success. A non-zero value indicates a failure to modify the button state.'
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
ClickButton method is in 2 classes of ROOT\virtualization\v2\ms_409 and in 2 namespaces
GetButtonState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
buttonIndexuint320-{'Description':'The 1-based index of the button to query.','In':True}
buttonStateboolean1-{'Description':'The current down state of the button. A TRUE value means the button is down.','Out':True}
Description'Retrieves the current state of the specified device button.
Return value: A return value of zero indicates success. A non-zero value indicates a query failure.'
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetButtonState method is in 2 classes of ROOT\virtualization\v2\ms_409 and in 2 namespaces
SetButtonState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
buttonIndexuint320-{'Description':'The 1-based index of the button to modify.','In':True}
buttonStateboolean1-{'Description':'The new down state of the button. A TRUE value means the button is down.','In':True}
Description'Sets the current state of the specified device button.
Return value: A return value of zero indicates success. A non-zero value indicates a failure to modify the button state.'
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
SetButtonState method is in 2 classes of ROOT\virtualization\v2\ms_409 and in 2 namespaces
SetRelativePosition method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
horizontalDeltasint80-{'Description':'The horizontal change for the mouse position, in pixels.','In':True}
verticalDeltasint81-{'Description':'The vertical change for the mouse position, in pixels.','In':True}
Description'Offsets the position of the mouse by the specified horizontal and vertical deltas.
Return value: A return value of zero indicates success. A non-zero value indicates a failure to alter the mouse position.'
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
SetRelativePosition method is in 1 class (Msvm_Ps2Mouse) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
SetScrollPosition method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
scrollPositionDeltasint80-{'Description':'The delta of the scroll position.','In':True}
Description'Adjusts the z-coordinate of the wheel control of the pointing device. Values written to this property are always relative coordinate offsets.
Return value: A return value of zero indicates success. A non-zero value indicates a failure to alter the scroll position.'
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
SetScrollPosition method is in 2 classes of ROOT\virtualization\v2\ms_409 and in 2 namespaces

Detailed description of Msvm_Ps2Mouse properties

Local properties (1) of Msvm_Ps2Mouse class

AbsoluteCoordinates property
CIMTYPE'boolean'
Description'Indicates whether the device operates on absolute coordinates. If not set, the device's coordinates are relative. This property is set to FALSE.'
AbsoluteCoordinates property is in 2 classes of ROOT\virtualization\v2\ms_409 and in 2 namespaces

Msvm_Ps2Mouse Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'Represents a PS2 mouse device. Instances of this class 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.'
LOCALE1033

Msvm_Ps2Mouse System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2\ms_409:Msvm_Ps2Mouse'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2\ms_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_PointingDevice', 'CIM_UserDevice', 'CIM_LogicalDevice', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT1___SYSTEM3
__RELPATH'Msvm_Ps2Mouse'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_PointingDevice'___SYSTEM8
__CLASS'Msvm_Ps2Mouse'___SYSTEM8
__GENUS1___SYSTEM3
comments powered by Disqus
WUtils.com