IddCxMonitorQueryHardwareCursor function (iddcx.h)

Article
02/22/2024

An indirect display driver calls IddCxMonitorQueryHardwareCursor to obtain updated hardware cursor information for the specified monitor. A driver that reports HDR support must use IddCxMonitorQueryHardwareCursor3 instead.

Syntax

NTSTATUS IddCxMonitorQueryHardwareCursor(
  [in]  IDDCX_MONITOR                 MonitorObject,
  [in]  const IDARG_IN_QUERY_HWCURSOR *pInArgs,
  [out] IDARG_OUT_QUERY_HWCURSOR      *pOutArgs
);

Parameters

[in] MonitorObject

An IDDCX_MONITOR object which is the monitor's OS context handle created by IddCxMonitorCreate.

[in] pInArgs

An IDARG_IN_QUERY_HWCURSOR structure containing this function's input arguments.

[out] pOutArgs

An IDARG_OUT_QUERY_HWCURSOR structure in which the monitor's current hardware cursor information is returned.

Return value

IddCxMonitorQueryHardwareCursor returns STATUS_SUCCESS if the operation succeeds; otherwise, it returns an appropriate NTSTATUS error code.

Remarks

The driver normally only calls this function when the event that signals cursor update has triggered.

For additional cursor information beyond what this function returns, call IddCxMonitorQueryHardwareCursor2 or IddCxMonitorQueryHardwareCursor3.

Requirements

Requirement	Value
Minimum supported client	Windows 10
Minimum supported server	Windows Server 2016
Target Platform	Windows
Header	iddcx.h
Library	IddCxStub.lib
DLL	IddCx.dll