IDirectDraw4::GetScanLine

  • Article

This method retrieves the scan line that is currently being drawn on the monitor.

HRESULT GetScanLine(
  LPDWORD lpdwScanLine
);

Parameters

  • lpdwScanLine
    Address of the variable that will contain the scan line the display is currently drawing.

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_UNSUPPORTED
DDERR_VERTICALBLANKINPROGRESS

Remarks

Scan lines are reported as zero-based integers. The returned scan line value is between 0 and n, where scan line 0 is the first visible scan line on the screen and n is the last visible scan line, plus any scan lines that occur during the vertical blank period. So, in a case where an application is running at 640×480, and there are 12 scan lines during the vertical blank period, the values returned by this method will range from 0 to 491.

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

IDirectDraw4::GetVerticalBlankStatus | IDirectDraw4::WaitForVerticalBlank

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.