Function GraPathEnd() | Xbase++

Ends the definition of a graphic path.

GraPathEnd( [<oPS>], [<lCloseFigure>] ) --> lSuccess

<oPS>

The argument <oPS> specifies the presentation space in which to end the definition of a graphic path. If the current window is an XbpCrt window, <oPS> is optional. If it is NIL, the return value of SetAppWindow():presSpace() is used. In all other cases <oPS> is not optional. It must be created using XbpPresSpace():new() or a "Micro PS" must be requested from an Xbase Part using the method :lockPS(). After graphic output the Micro PS must be released with :unlockPS().

<lCloseFigure> is a logical value specifying whether the drawing defined as a graphical path is to be closed. The default value is .F. (false), meaning the path includes only the defined graphic primitives. If <lCloseFigure> equals .T. (true), the starting point of the first graphic primitive is connected to the end point of the last graphic primitive.

The return value of GraPathEnd() is .T. (true) when the path was successfully defined, otherwise it is .F. (false). If the return value equals .F., the cause of error can be determined with GraError().

The function GraPathEnd() ends the definition of a graphic path. It must always be executed after a call of GraPathBegin() (see GraPathBegin()) and before the execution of a path operation. Path operations are executed by the functions GraPathFill(), GraPathClip() and GraPathOutline(). After a path operation occurs, the path definition is discarded.

When the graphic path should be filled, .T. (true) should always be specified for <lCloseFigure>. Otherwise, if a path has areas which are not closed, the entire presentation space in which the path was defined is filled by GraPathFill().

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.

Function GraPathEnd() Foundation