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.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPATHS
 
LONG GpiOutlinePath(hps, lPath, lOptions)
HPS hps;          /* presentation-space handle      */
LONG lPath;       /* identifies path to be outlined */
LONG lOptions;    /* reserved, must be zero         */
 
The GpiOutlinePath function draws an outline of a path using the current
line attributes. This function draws the outline such that each line, curve,
and other item in the path appears to be drawn individually; it does not
close the path. GpiOutlinePath draws the path using the current cosmetic
line width (see the GpiSetLineWidth function); it does not fill the path.
GpiOutlinePath deletes the path after drawing the outline.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
lPath      Identifies the path to be outlined. For MS OS/2 version 1.2, this
           parameter must be set to 1.
 
lOptions   Specifies outline options. For MS OS/2 version 1.2, this
           parameter must be set to zero.
 
Return Value
 
The return value is GPI_OK if the function is successful or GPI_ERROR if an
error occurs.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_HPS
     PMERR_INV_PATH_ID
     PMERR_INV_RESERVED_FIELD
     PMERR_PATH_UNKNOWN
     PMERR_PS_BUSY
 
Comments
 
If character strings are in the path, the function draws the outline of each
character but does not fill the interior of the character, giving the
appearance of hollow characters. For small characters, outlining in this way
can give a visual appearance similar to filled characters, but with improved
performance.
 
See Also
 
GpiBeginPath, GpiEndPath, GpiSetLineWidth, WinGetLastError
 
                                      ♦