Microsoft Windows CE 3.0  

IDirectDrawSurface5::GetAttachedSurface

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectDrawSurface5::GetAttachedSurfacemethod obtains the attached surface that has the specified capabilities and increments the reference count of the retrieved interface.

HRESULT GetAttachedSurface(
LPDDSCAPS2
lpDDSCaps
,
LPDIRECTDRAWSURFACE4 FAR
*lplpDDAttachedSurface
);

Parameters

lpDDSCaps
Address of a DDSCAPS2structure that contains the hardware capabilities of the surface.
lplpDDAttachedSurface
Address of a variable that will contain a pointer to the retrieved surface's IDirectDrawSurface5interface. The retrieved surface is the one that matches the description according to the lpDDSCapsparameter.

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

Attachments are used to connect multiple DirectDrawSurfaceobjects into complex structures, like the ones needed to support 3-D page flipping with Z-buffers. This method fails if more than one surface is attached that matches the capabilities requested. In this case, the application must use the IDirectDrawSurface5::EnumAttachedSurfacesmethod to obtain the attached surfaces.

Requirements

Runs on Versions Declared in Link to
Windows CE OS 2.12 or later. Version 2.12 requires DXPAK 1.0 or later. ddraw.h ddraw.lib