IDirectDrawSurface4::FreePrivateData

The IDirectDrawSurface4::FreePrivateData method 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::Release method on the associated interface.

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.

See Also

IDirectDrawSurface4::GetPrivateData, IDirectDrawSurface4::SetPrivateData