IDirectDrawSurface3::GetOverlayPosition

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

HRESULT GetOverlayPosition(
  LPLONG lplX, 
  LPLONG lplY  
);
 

Parameters

lplX and lplY
Addresses of the x- and y-display coordinates.

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_GENERIC
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDPOSITION
DDERR_NOOVERLAYDEST
DDERR_NOTAOVERLAYSURFACE
DDERR_OVERLAYNOTVISIBLE
DDERR_SURFACELOST

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.

See Also

IDirectDrawSurface3::SetOverlayPosition, IDirectDrawSurface3::UpdateOverlay