GetPointerCursorId function

Retrieves the cursor identifier associated with the specified pointer.

Syntax

BOOL GetPointerCursorId(
  UINT32 pointerId,
  UINT32 *cursorId
);

Parameters

pointerId

An identifier of the pointer for which to retrieve the cursor identifier.

cursorId

An address of a UINT32 to receive the tablet cursor identifier, if any, associated with the specified pointer.

Return Value

If the function succeeds, the return value is non-zero.

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

Remarks

Cursor objects represent pointing and selecting devices used with digitizer devices, most commonly tactile contacts on touch digitizers and tablet pens on pen digitizers. Physical pens may have multiple tips (such as normal and eraser ends), with each pen tip representing a different cursor object. Each cursor object has an associated cursor identifier.

For pointer types that derive from these cursor objects, an application can use the GetPointerCursorId function to retrieve the cursor identifier associated with a pointer.

Requirements

   
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See Also

Functions