Share via

IDirectDrawSurface::GetOverlayPosition

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

Given a visible, active overlay surface (DDSCAPS_OVERLAY flag set), this method returns the display coordinates of the surface.

Syntax

HRESULT GetOverlayPosition(
  LPLONG lplX, 
  LPLONG lplY
);

Parameters

  • lplX
    Address of the x-display coordinates.
  • lplY
    Address of the y-display coordinates.

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_GENERIC

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_INVALIDPOSITION

DDERR_NOOVERLAYDEST

DDERR_NOTAOVERLAYSURFACE

DDERR_OVERLAYNOTVISIBLE

DDERR_SURFACELOST

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::SetOverlayPosition
IDirectDrawSurface::UpdateOverlay