CanvasSetPenPosition
int CanvasSetPenPosition (int panelHandle, int controlID, Point point);
Purpose
Sets the position of the canvas pen.
CanvasDrawLineTo is the only canvas drawing function that uses the pen position.
Supported Controls
You can use CanvasSetPenPosition with canvas controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| point | Point | Point structure that specifies the new position of the canvas pen. The Point structure is defined as follows. typedef struct { int x; int y; } Point; You can create a Point without having to declare a variable by using the following function: Point MakePoint (int x, int y); ExampleCanvasSetPenPosition (panelHandle, controlID, MakePoint (20, 30)); |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Example
Refer to userint\canvas.cws for an example of using the CanvasSetPenPosition function.