IDirectDrawSurface5::UpdateOverlayZOrder

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::UpdateOverlayZOrdermethod sets the Z-order of an overlay.

HRESULT UpdateOverlayZOrder(
DWORD
dwFlags
,
LPDIRECTDRAWSURFACE4
lpDDSReference
);

Parameters

dwFlags

One of the following flags:

DDOVERZ_INSERTINBACKOF	Inserts this overlay in the overlay chain behind the reference overlay.
DDOVERZ_INSERTINFRONTOF	Inserts this overlay in the overlay chain in front of the reference overlay.
DDOVERZ_MOVEBACKWARD	Moves this overlay one position backward in the overlay chain.
DDOVERZ_MOVEFORWARD	Moves this overlay one position forward in the overlay chain.
DDOVERZ_SENDTOBACK	Moves this overlay to the back of the overlay chain.
DDOVERZ_SENDTOFRONT	Moves this overlay to the front of the overlay chain.

lpDDSReference

Address of the IDirectDrawSurface5interface for the DirectDraw surface to be used as a relative position in the overlay chain. This parameter is needed only for DDOVERZ_INSERTINBACKOF and DDOVERZ_INSERTINFRONTOF.

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_NOTAOVERLAYSURFACE

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

See Also

IDirectDrawSurface5::EnumOverlayZOrders