GetButtonState method of the Msvm_SyntheticMouse class

Retrieves the current state of the specified device button.

Syntax


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

Parameters

buttonIndex [in]

Type: uint32

The 1-based index of the button to query.

isDown [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.

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

Namespace

Root\Virtualization

MOF

WindowsVirtualization.mof

See also

Msvm_SyntheticMouse

 

 

Show: