IddCxMonitorQueryHardwareCursor2 function (iddcx.h)

Article
10/23/2023

An indirect display driver calls IddCxMonitorQueryHardwareCursor2 to retrieve the current hardware cursor information for the specified monitor. A driver that reports HDR support must use IddCxMonitorQueryHardwareCursor3 instead.

Syntax

NTSTATUS IddCxMonitorQueryHardwareCursor2(
  IDDCX_MONITOR                 MonitorObject,
  const IDARG_IN_QUERY_HWCURSOR *pInArgs,
  IDARG_OUT_QUERY_HWCURSOR2     *pOutArgs
);

Parameters

MonitorObject

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

pInArgs

[in] Pointer to an IDARG_IN_QUERY_HWCURSOR structure containing this function's input arguments.

pOutArgs

[out] Pointer to an IDARG_OUT_QUERY_HWCURSOR2 structure in which the monitor's current hardware cursor information is returned.

Return value

IddCxMonitorQueryHardwareCursor2 returns STATUS_SUCCESS upon success; 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.

Although IddCxMonitorQueryHardwareCursor2 can be used by both console and remote drivers, the additional information provided when compared to IddCxMonitorQueryHardwareCursor is only useful for remote drivers.

Requirements

Requirement	Value
Minimum supported client	Windows 11, version 22H2
Header	iddcx.h