IVMMouse::GetButton method

[Windows Virtual PC is no longer available for use as of Windows 8. Instead, use the Hyper-V WMI provider (V2).]

Retrieves the current state (up or down) of the specified mouse button.

Syntax

HRESULT GetButton(
  [in]          VMMouseButton buttonIndex,
  [out, retval] VARIANT_BOOL  *isDown
);

buttonIndex [in]: The index of the button whose state is being requested. For a list of values, see VMMouseButton.
isDown [out, retval]: The state of the indicated button. TRUE if the button is currently down in the virtual machine, FALSE otherwise.

This method can return one of these values.

Return code/value	Description
S_OK 0	The operation was successful.
E_POINTER 0x80004003	The isDown parameter is NULL.
E_INVALIDARG 0x80000003	The buttonIndex parameter is not valid.
VM_E_VM_NOT_RUNNING 0xA0040206	The virtual machine to which this mouse device is attached is not currently running.
VM_E_MOUSE_NOT_ACTIVE 0xA0040800	The mouse device has not been powered up.
DISP_E_EXCEPTION 0x80020009	An unexpected error has occurred.

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	None supported
End of client support	Windows 7
Product	Windows Virtual PC
Header	VPCCOMInterfaces.h
IID	IID_IVMmouse is defined as ac903f6d-6346-4f29-8875-5d511a13895e

Was this page helpful?