Share via

IDirectDrawSurface5::FreePrivateData

  • Article

This 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:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_NOTFOUND

Remarks

DirectDraw calls this method automatically when a surface is released.

Requirements

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Ddraw.h.
Link Library: Ddraw.lib.

See Also

IDirectDrawSurface5::GetPrivateData | IDirectDrawSurface5::SetPrivateData

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.