Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

                                                     ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
WORD Output(lpDestDev, OS_BEGINNSCAN, 0, NULL, lpPPen, lpPBrush,
            lpDrawMode, NULL)
LPPDEVICE lpDestDev;
LPPPEN lpPPen;
LPPBRUSH lpPBrush;
LPDRAWMODE lpDrawMode;
 
The OS_BEGINNSCAN style specifies that the Output function prepares for a
subsequent series of calls to the Output function in which the OS_SCANLINES
style is specified.
 
Every graphics driver (for Windows versions 2.0 and later) should support
the OS_BEGINNSCAN style.
 
Parameter   Description
────────────────────────────────────────────────────────────────────────────
 
lpDestDev   Points to a PDEVICE or PBITMAP structure specifying the
            destination device or bitmap.
 
lpPPen      Points to a PPEN structure specifying the physical pen to draw
            subsequent scan lines. If it is NULL, no pen is used.
 
lpPBrush    Points to a PBRUSH structure specifying the physical brush to
            draw subsequent scan lines. If it is NULL, no brush is used.
 
lpDrawMode  Points to a DRAWMODE structure containing drawing information
            when drawing subsequent scan lines.
 
Return Value
 
The return value is 1.
 
Comments
 
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 the Output function with the OS_BEGINNSCAN style to let the
driver prepare the drawing mode and physical pen and brush for use in
subsequent calls containing 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 on each subsequent call to the Output function regardless of
whether the driver prepared these objects previously.
 
See Also
 
Output(OS_ENDNSCAN)
 
 
                                      ♦