# CanvasDrawLine

int CanvasDrawLine (int panelHandle, int controlID, Point start, Point end);

## Purpose

Draws a line between two specified points.

CanvasDrawLine 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)

## Parameters

Input
Name | Type | Description
panelHandle | integer | Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID | integer | 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 NewCtrl or DuplicateCtrl.
start | Point | Point structure specifying the location at which the line begins. 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); Example CanvasDrawLine (panelHandle, controlID, MakePoint (20, 30), endPoint);
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); Example CanvasDrawLine (panelHandle, controlID, startPoint, MakePoint (90, 80));

## Return Value

Name | Type | Description
status | integer | Return value indicating whether the function was successful. A negative number indicates that an error occurred.
Code | Error Message String
xx | Success