Share via


IDirectDraw::GetScanLine

Send Feedback

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

Pocket PC: Windows Mobile 5.0 and later
Smartphone: Windows Mobile 5.0 and later
OS Versions: Windows CE 5.01 and later
Header: Ddraw.h.
Library: Ddraw.lib.

See Also

IDirectDraw::GetVerticalBlankStatus | IDirectDraw::WaitForVerticalBlank

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.