IDirectDrawSurface7::FreePrivateData method

Frees the specified private data that is associated with this surface.

Syntax


HRESULT FreePrivateData(
  [in] REFGUID guidTag
);

Parameters

guidTag [in]

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

Return value

If the method succeeds, the return value is DD_OK.

If it fails, the method can return one of the following error values:

  • DDERR_INVALIDOBJECT
  • DDERR_INVALIDPARAMS
  • DDERR_NOTFOUND

Remarks

DirectDraw calls this method automatically when a surface is released.

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

You must use LoadLibrary to explicitly link to Ddraw.dll and then use GetProcAddress to access the FreePrivateData method.

Requirements

Header

Ddraw.h

Library

Ddraw.lib

DLL

Ddraw.dll

See also

IDirectDrawSurface7

 

 

Show: