GpiBeginInkPath: Difference between revisions
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Undocumented]] | [[Category:Undocumented]] | ||
This is an '''undocumented''' function. | |||
Its purpose is to initiate the creation of an ink path, a feature used for drawing and manipulating shapes that are defined by a sequence of points. | |||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 13: | ||
==Return== | ==Return== | ||
;''rc'' ([[BOOL]]) - return: | ;''rc'' ([[BOOL]]) - return :A value indicating the success or failure of the function call. A return value of 1 indicates success, while a return value of 0 indicates an error. | ||
==Remarks== | |||
GpiBeginInkPath must be called before any drawing functions that define the points of the path, such as GpiMove or GpiLine. The path is considered "open" after this call. The path is concluded by a call to GpiEndInkPath, which closes the path and can be used to render the final shape. | |||
== Related Methods== | |||
* [[GpiEndInkPath]] | |||
* [[GpiMove]] | |||
* [[GpiLine]] | |||
[[Category:Gpi]] | [[Category:Gpi]] | ||
Latest revision as of 22:07, 8 October 2025
This is an undocumented function.
Its purpose is to initiate the creation of an ink path, a feature used for drawing and manipulating shapes that are defined by a sequence of points.
Syntax
GpiBeginInkPath (hps, lPath, flOptions);
Parameters
- hps (HPS) - input
- Handle to the presentation space. This handle defines the graphics context in which the path will be drawn.
- lPath (LONG) - input
- flOptions (ULONG) - input
- A flag that specifies options for the ink path. This can be set to 0.
Return
- rc (BOOL) - return
- A value indicating the success or failure of the function call. A return value of 1 indicates success, while a return value of 0 indicates an error.
Remarks
GpiBeginInkPath must be called before any drawing functions that define the points of the path, such as GpiMove or GpiLine. The path is considered "open" after this call. The path is concluded by a call to GpiEndInkPath, which closes the path and can be used to render the final shape.