# CanvasGetClipRect

int CanvasGetClipRect (int panelHandle, int controlID,Rect *clipRect);

## Purpose

Obtains the current 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.

## 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.
Output
Name | Type | Description
clipRect | Rect | Rect structure that contains the location and size of the current clipping area. If clipping is disabled (the default state), the function sets the height and width values in the structure to zero. The Rect structure is defined as follows: typedef struct { int top; int left; int height; int width; } Rect;

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