get_clipping_region


int get_clipping_region(handle device,
                        handle region)

This function obtains the application defined clipping region.

Parameters

handle device

The handle of the device context.

handle region

The handle of a region that is updated to contain the application defined clipping region.

Return

int

false The device context has no clipping region.
true The clipping region of the device context was copied to the specified region.
-1 An error occurred - the call failed.

Notes

The application defined clipping region is the region set through the function select_clipping_region. This is not the same as the clipping region of a device context created through the function begin_paint.

A copy of the application defined clipping region is returned. Changes to that copy are not reflected in the original - that is, the application defined clipping region of the device context remains unchanged.