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.

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_SyntheticMouse 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

See also

Msvm_SyntheticMouse