CanvasDrawLineTo
int CanvasDrawLineTo (int panelHandle, int controlID, Point end);
Purpose
Draws a line between the current pen position and an end point you specify, and sets the pen position to the end point.
CanvasDrawLineTo draws the line using the current value of the following attributes:
ATTR_PEN_COLOR
ATTR_PEN_MODE
ATTR_PEN_WIDTH
ATTR_PEN_STYLE (ignored when pen width is greater than one)
Supported Controls
You can use CanvasDrawLineTo 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. |
| end | Point | Point structure specifying the location at which the line ends. 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); ExampleCanvasDrawLineTo (panelHandle, controlID, MakePoint (90, 80)); |
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
Examples
Refer to the following examples that use the CanvasDrawLineTo function:
- userint\canvas.cws
Open example - userint\canvsbmk.cws
Open example