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.

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.
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);

Example

CanvasSetPenPosition (panelHandle, controlID, MakePoint (20, 30));

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