NtGdiDdDestroySurface function

Article
01/06/2021

[This function is subject to change with each operating system revision. Instead, use the DirectDraw and Microsoft Direct3DAPIs; these APIs insulate applications from such operating system changes, and hide many other difficulties involved in interacting directly with display drivers.]

Destroys a previously allocated kernel-mode Microsoft DirectDraw surface object.

Syntax

DWORD APIENTRY NtGdiDdDestroySurface(
  _In_ HANDLE hSurface,
  _In_ BOOL   bRealDestroy
);

Parameters

hSurface [in]: Handle to previously allocated kernel-mode surface object.
bRealDestroy [in]: Specifies how to destroy the surface. Can be one of the following values.
(TRUE): Destroy the surface and free video memory.
(FALSE): Free the video memory but leave the surface in an uninitialized state.

Return value

NtGdiDdDestroySurface returns one of the following callback codes.

Return code	Description
DDHAL_DRIVER_HANDLED	The driver has performed the operation and returned a valid return code for that operation. If this code is DD_OK, DirectDraw or Direct3D proceeds with the function. Otherwise, DirectDraw or Direct3D returns the error code provided by the driver and aborts the function.
DDHAL_DRIVER_NOTHANDLED	The driver has no comment on the requested operation. If the driver is required to have implemented a particular callback, DirectDraw or Direct3D reports an error condition. Otherwise, DirectDraw or Direct3D handles the operation as if the driver callback had not been defined by executing the DirectDraw or Direct3D device-independent implementation.

Remarks

It is recommended that applications use the DirectDraw and Direct3D APIs to create and destroy surfaces instead of this function.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Ntgdi.h