Output(OS_BEGINNSCAN)

WORD Output(LPPDEVICE lpDestDev, WORD wStyle, WORD wCount, 
    LPPOINT lpPoints, LPPPen lpPPen, LPPBrush lpPBrush, 
    LPDRAWMODE lpDrawMode, LPRECT lpClipRect);

Prepares for a subsequent series of calls to the Output function in which the OS_SCANLINES or OS_POLYSCANLINE style is specified.

• Returns 1 if the function is successful.

lpDestDev

Address of a PDEVICE or PBITMAP structure that specifies the destination device or bitmap.

wStyle

Must be OS_BEGINNSCAN

wCount

Must be 0.

lpPoints

Must be NULL.

lpPPen

Address of a PPEN structure that specifies the physical pen that is used to draw subsequent scan lines. If it is NULL, no pen is used.

lpPBrush

Address of a PBRUSH structure that specifies the physical brush that is used to draw subsequent scan lines. If it is NULL, no brush is used.

lpDrawMode

Address of a DRAWMODE structure that contains drawing information when drawing subsequent scan lines.

lpClipRect

Must be NULL.

Every graphics driver (for Windows versions 2.0 and later) should support the OS_BEGINNSCAN style.

GDI uses the OS_BEGINNSCAN and OS_ENDNSCAN styles to mark the beginning and end of a series of scan lines that use the same pen, brush, and drawing mode. GDI calls Output with the OS_BEGINNSCAN style to let the driver prepare the drawing mode and the physical pen and brush for use in subsequent calls that contains the OS_SCANLINE style. Drivers that preserve these objects between calls to Output can improve performance by minimizing the number of times the objects need to be set up. All subsequent calls using the OS_SCANLINE style will use the same objects until GDI calls with a matching OS_ENDNSCAN style.

If a driver does not support the OS_BEGINNSCAN style, the driver can ignore the style. In all cases, GDI passes the physical pen, physical brush, and drawing mode upon each subsequent call to Output regardless of whether the driver previously prepared these objects.

See also Output(OS_ENDNSCAN), PDEVICE, PBITMAP, DRAWMODE, RECT, POINT