# CanvasSetClipRect

int CanvasSetClipRect (int panelHandle, int controlID, Rect clipRect);

## Purpose

Sets the clipping rectangle for the canvas control. Canvas drawing operations do not extend beyond the clipping rectangle. Any drawing outside the clipping rectangle is not shown. The exception is CanvasClear, which is not limited to the clipping rectangle.

Changing the clipping rectangle does not affect the current contents of the canvas.

In the initial state for a canvas control, clipping is disabled.

## 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.
clipRect | Rect | Rect structure specifying into the location and size of the clipping rectangle. To disable clipping, set the height and width of clipRect to zero, or use VAL_EMPTY_RECT. The Rect structure is defined as follows: typedef struct { int top; int left; int height; int width; } Rect; You can create a Rect without having to declare a variable by using the following function: Rect MakeRect (int top, int left, int height, int width); Example CanvasSetClipRect (panelHandle, controlID, MakeRect(20,30,50,50));

## 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