gpi12.hlp (Table of Contents; Topic list)
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.
GpiSetLineEnd (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIPRIMITIVES
 
BOOL GpiSetLineEnd(hps, lLineEnd)
HPS hps;          /* presentation-space handle */
LONG lLineEnd;    /* line end                  */
 
The GpiSetLineEnd function sets the current line-end attribute. The line-end
attribute specifies the shape of the ends of lines drawn by the
GpiStrokePath function or by the GpiModifyPath and GpiFillPath function
pair.
 
If the attribute mode is AM_PRESERVE, the function saves the previous
line-end attribute on the attribute stack when it sets the new line end. The
previous line-end attribute can be retrieved by using the GpiPop function.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies a presentation space.
 
lLineEnd   Specifies the line end. It may be one of the following values:
 
           Value            Meaning
           ─────────────────────────────────────────────────────────────────
           LINEEND_DEFAULT  Use default.
 
           LINEEND_FLAT     Flat. The line is ended at the end point of the
                            original path.
 
           LINEEND_ROUND    Round. The line is ended as if a circle having a
                            diameter equal to the line width is drawn
                            centered on the end point of the original path.
 
           LINEEND_SQUARE   Square. The line is ended as if a square having
                            the same width as the line is drawn centered on
                            the end point of the original path.
 
Return Value
 
The return value is TRUE if the function is successful. Otherwise, it is
FALSE, indicating that an error occurred.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_INV_HPS
     PMERR_INV_LINE_END_ATTR
     PMERR_PS_BUSY
 
See Also
 
GpiFillPath, GpiModifyPath, GpiPop, GpiQueryAttrs, GpiQueryLineEnd,
GpiSetAttrMode, WinGetLastError