IDirectDrawSurface5::UpdateOverlayZOrder

This method sets the Z-order of an overlay.

HRESULT UpdateOverlayZOrder(
  DWORD dwFlags, 
  LPDIRECTDRAWSURFACE4 lpDDSReference
); 

Parameters

• dwFlags
  The following table shows the possible flags.

  Flag	Description
  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 IDirectDrawSurface5 interface 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:

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

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.