Share via


GetButtonState method of the Msvm_Ps2Mouse class

Retrieves the current state of the specified device button.

Syntax

uint32 GetButtonState(
  [in]  uint32  buttonIndex,
  [out] boolean buttonState
);

Parameters

buttonIndex [in]

Type: uint32

The 1-based index of the button to query.

buttonState [out]

Type: boolean

The current down state of the button. A TRUE value means the button is down.

Return value

Type: uint32

A return value of zero indicates success. A nonzero value indicates a query failure.

Completed with No Error (0)

Method Parameters Checked - Job Started (4096)

Failed (32768)

Access Denied (32769)

Not Supported (32770)

Status is unknown (32771)

Timeout (32772)

Invalid parameter (32773)

System is in used (32774)

Invalid state for this operation (32775)

Incorrect data type (32776)

System is not available (32777)

Out of memory (32778)

Remarks

Access to the Msvm_Ps2Mouse 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
Header
Mmc.h
MOF
WindowsVirtualization.mof

See also

Msvm_Ps2Mouse