CanvasDefaultPen
int CanvasDefaultPen (int panelHandle, int controlID);
Purpose
Sets all of the attributes of the canvas pen to the default values. The defaults appear in the following table.
| Canvas Pen Attribute | Default Value |
| ATTR_PEN_WIDTH | 1 |
| ATTR_PEN_STYLE | VAL_SOLID |
| ATTR_PEN_COLOR | VAL_BLACK |
| ATTR_PEN_FILL_COLOR | VAL_BLACK |
| ATTR_PEN_MODE | VAL_COPY_MODE |
| ATTR_PEN_PATTERN | A solid pattern, expressed as an array of eight unsigned characters, each of which is 0xFF. |
Supported Controls
You can use CanvasDefaultPen 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. |
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