IDirectDrawSurface7::DeleteAttachedSurface

The IDirectDrawSurface7::DeleteAttachedSurface method detaches two attached surfaces.

HRESULT DeleteAttachedSurface(
  DWORD dwFlags,                             
  LPDIRECTDRAWSURFACE7 lpDDSAttachedSurface  
);

Parameters

dwFlags

Currently not used and must be set to 0.

lpDDSAttachedSurface

Address of the IDirectDrawSurface7 interface for the DirectDrawSurface object to be detached. If this parameter is NULL, all attached surfaces are detached.

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

This method decrements the reference count of the surface to be detached. If the reference count of the surface to be detached reaches 0, it is lost and removed from memory.

Implicit attachments, those formed by DirectDraw rather than the IDirectDrawSurface7::AddAttachedSurface method, cannot be detached. Detaching surfaces from a flipping chain can alter other surfaces in the chain. If a front buffer is detached from a flipping chain, the next surface in the chain becomes the front buffer, and the following surface becomes the back buffer. If a back buffer is detached from a chain, the following surface becomes a back buffer. If a plain surface is detached from a chain, the chain simply becomes shorter. If a flipping chain has only two surfaces and they are detached, the chain is destroyed, and both surfaces return to their previous designations.

Requirements

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

See Also

IDirectDrawSurface7::Flip