PFND3DDDI_FINISHSESSIONKEYREFRESH callback function (d3dumddi.h)

Article
02/22/2024

The FinishSessionKeyRefresh function indicates that all buffers from that point in time use the updated session key value.

Syntax

PFND3DDDI_FINISHSESSIONKEYREFRESH Pfnd3dddiFinishsessionkeyrefresh;

HRESULT Pfnd3dddiFinishsessionkeyrefresh(
  HANDLE hDevice,
  const D3DDDIARG_FINISHSESSIONKEYREFRESH *unnamedParam2
)
{...}

Parameters

hDevice

A handle to the display device (graphics context).

unnamedParam2

pData [in]

A pointer to a D3DDDIARG_FINISHSESSIONKEYREFRESH structure that describes the session.

Return value

FinishSessionKeyRefresh returns one of the following values:

Return code	Description
S_OK	The session is successfully updated.
D3DDDIERR_NOTAVAILABLE	The driver does not support the FinishSessionKeyRefresh function.

Remarks

The hardware and driver can optionally support the FinishSessionKeyRefresh function for all crypto types.

When the Direct3D runtime calls the driver's StartSessionKeyRefresh function, the driver generates and saves a random number and returns the random number in the buffer that the pRandomNumber member of the D3DDDIARG_STARTSESSIONKEYREFRESH structure points to.

When the runtime subsequently calls the driver's FinishSessionKeyRefresh function, the driver performs an XOR operation of the random number with the session key.

Requirements

Requirement	Value
Minimum supported client	The FinishSessionKeyRefresh function is supported beginning with the Windows 7 operating system.
Target Platform	Desktop
Header	d3dumddi.h (include D3dumddi.h)