IDirectDrawSurface5::FreePrivateData

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectDrawSurface5::FreePrivateDatamethod frees the specified private data associated with this surface.

HRESULT FreePrivateData(
REFGUID
guidTag
,);

Parameters

guidTag

Reference to (C++) or address of (C) the globally unique identifier that identifies the private data to be freed.

Return Values

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

Remarks

DirectDraw calls this method automatically when a surface is released.

If the private data was set by using the DDSPD_IUNKNOWNPOINTER flag, this method calls the IUnknown::Releasemethod on the associated interface.

Requirements

Runs on	Versions	Declared in	Link to
Windows CE OS	2.12 or later. Version 2.12 requires DXPAK 1.0 or later.	ddraw.h	ddraw.lib