Share via

IDirectDrawSurface::UpdateOverlayZOrder

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method sets the Z-order of an overlay.

Syntax

HRESULT UpdateOverlayZOrder(
  DWORD dwFlags, 
  LPDIRECTDRAWSURFACE 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 IDirectDrawSurface 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 Value

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

For more information on these error codes see DirectDraw Return Values.

Requirements

Header ddraw.h
Library ddraw.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later

See Also

Reference

IDirectDrawSurface::EnumOverlayZOrders