IDirectDrawSurface7::FreePrivateData

The IDirectDrawSurface7::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 it fails, the method can return 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.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 98.
  Header: Declared in ddraw.h.

See Also

IDirectDrawSurface7::GetPrivateData, IDirectDrawSurface7::SetPrivateData