DXGKDDI_DISPLAYMUX_PRE_SWITCH_AWAY_GET_PRIVATE_DATA callback function (dispmprt.h)

Dxgkrnl calls the DxgkddiDisplayMuxPreSwitchAwayGetPrivateData function of the kernel-mode display driver (KMD) currently connected to the panel to retrieve any private data from it.

Syntax

DXGKDDI_DISPLAYMUX_PRE_SWITCH_AWAY_GET_PRIVATE_DATA DxgkddiDisplaymuxPreSwitchAwayGetPrivateData;

NTSTATUS DxgkddiDisplaymuxPreSwitchAwayGetPrivateData(
  PVOID DriverContext,
  ULONG VidPnTargetId,
  ULONG SwitchPrivateDataSize,
  PVOID pSwitchPrivateDataBuffer,
  GUID *pSwitchPrivateDataGUID
)
{...}

Parameters

DriverContext

[in] Handle to a context block that is associated with a display adapter. KMD's DxgkDdiAddDevice function previously provided this handle to Dxgkrnl.

VidPnTargetId

[in] The VidPN target that the DDI is being called for.

SwitchPrivateDataSize

[in] The size, in bytes, of the buffer that pSwitchPrivateDataBuffer points to. The driver provided this value to Dxgkrnl in a previous call to DxgkddiDisplayMuxPreSwitchAway.

pSwitchPrivateDataBuffer

[in] Pointer to the allocated buffer in which the driver should copy the switch private data to.

pSwitchPrivateDataGUID

[out] Pointer to a variable in which the driver should write the GUID that describes the switch private data. The driver must set a non-zero GUID.

Return value

DxgkddiDisplayMuxPreSwitchAwayGetPrivateData returns STATUS_SUCCESS if it succeeds. Otherwise, it returns an appropriate NT_STATUS error code.

Remarks

This DDI is called under synchronization level 2.

For more information, see Automatic Display Switch.

Requirements

Requirement	Value
Minimum supported client	Windows 11, version 24H2, update 2025.01
Header	dispmprt.h
IRQL	PASSIVE_LEVEL

See also

DxgkddiDisplayMuxPreSwitchAway