DXGKDDI_OPM_CONFIGURE_PROTECTED_OUTPUT callback function (dispmprt.h)

Article
02/22/2024

The DXGKDDI_OPM_CONFIGURE_PROTECTED_OUTPUT function configures the given protected output object.

Syntax

DXGKDDI_OPM_CONFIGURE_PROTECTED_OUTPUT DxgkddiOpmConfigureProtectedOutput;

NTSTATUS DxgkddiOpmConfigureProtectedOutput(
  [in] PVOID MiniportDeviceContext,
  [in] HANDLE ProtectedOutputHandle,
  [in] const DXGKMDT_OPM_CONFIGURE_PARAMETERS *Parameters,
  [in] ULONG AdditionalParametersSize,
  [in] const VOID *AdditionalParameters
)
{...}

Parameters

[in] MiniportDeviceContext

A handle to a context block associated with a display adapter. The display miniport driver's DxgkDdiAddDevice function previously provided this handle to the DirectX graphics kernel subsystem.

[in] ProtectedOutputHandle

The handle to a protected output object. The DxgkDdiOPMCreateProtectedOutput function creates the protected output object and returns the handle to the object.

[in] Parameters

A pointer to a DXGKMDT_OPM_CONFIGURE_PARAMETERS structure that contains parameters that are used to configure the protected output object whose handle is specified in the ProtectedOutputHandle parameter.

[in] AdditionalParametersSize

The size, in bytes, of the additional parameters in the buffer that is pointed to by AdditionalParameters. For Certified Output Protection Protocol (COPP) emulation, this is 0.

[in] AdditionalParameters

A pointer to a buffer that holds the additional parameters that are used to configure the protected output object whose handle is specified in the ProtectedOutputHandle parameter. For COPP emulation, this is NULL. If the AdditionalParametersSize parameter is set to 0, AdditionalParameters is always set to NULL.

Return value

DXGKDDI_OPM_CONFIGURE_PROTECTED_OUTPUT returns one of the following values:

Return code	Description
STATUS_SUCCESS	The function successfully configured the protected output object.
STATUS_NO_MEMORY	DxgkDdiOPMConfigureProtectedOutput cannot allocate memory required for it to complete.

This function might also return other error codes that are defined in Ntstatus.h.

Remarks

The DirectX graphics kernel subsystem calls DxgkDdiOPMGetInformation or DxgkDdiOPMGetCOPPCompatibleInformation to retrieve information about the output and then calls DXGKDDI_OPM_CONFIGURE_PROTECTED_OUTPUT one or more times to configure the output.

DXGKDDI_OPM_CONFIGURE_PROTECTED_OUTPUT should be made pageable.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dispmprt.h (include Dispmprt.h)
IRQL	PASSIVE_LEVEL (see Remarks section)