GetNumberOfConsoleMouseButtons function (Windows)

Applies to: desktop apps only

Retrieves the number of buttons on the mouse used by the current console.

Syntax

BOOL WINAPI GetNumberOfConsoleMouseButtons(
  __out  LPDWORD lpNumberOfMouseButtons
);

Parameters

lpNumberOfMouseButtons [out]

A pointer to a variable that receives the number of mouse buttons.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

When a console receives mouse input, an INPUT_RECORD structure containing a MOUSE_EVENT_RECORD structure is placed in the console's input buffer. The dwButtonState member of MOUSE_EVENT_RECORD has a bit indicating the state of each mouse button. The bit is 1 if the button is down and 0 if the button is up. To determine the number of bits that are significant, use GetNumberOfConsoleMouseButtons.

Requirements

See also

Console Functions

Console Input Buffer

ReadConsoleInput

INPUT_RECORD

MOUSE_EVENT_RECORD

Send comments about this topic to Microsoft

Build date: 2/3/2012