PFND3DDDI_STARTSESSIONKEYREFRESH callback function (d3dumddi.h)

Article
02/22/2024

The StartSessionKeyRefresh function returns a random number that the driver's FinishSessionKeyRefresh function subsequently uses to perform an exclusive OR operation (XOR) with the session key.

Syntax

PFND3DDDI_STARTSESSIONKEYREFRESH Pfnd3dddiStartsessionkeyrefresh;

HRESULT Pfnd3dddiStartsessionkeyrefresh(
  HANDLE hDevice,
  const D3DDDIARG_STARTSESSIONKEYREFRESH *unnamedParam2
)
{...}

Parameters

hDevice

A handle to the display device (graphics context).

unnamedParam2

pData [in, out]

A pointer to a D3DDDIARG_STARTSESSIONKEYREFRESH structure that contains information about the random number.

Return value

StartSessionKeyRefresh returns one of the following values:

Return code	Description
S_OK	The random number is successfully returned.
D3DDDIERR_NOTAVAILABLE	The driver does not support the StartSessionKeyRefresh function.

Remarks

The hardware and driver can optionally support StartSessionKeyRefresh 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	StartSessionKeyRefresh is supported beginning with the Windows 7 operating system.
Target Platform	Desktop
Header	d3dumddi.h (include D3dumddi.h)