Skip to content

IGR_Canvas_Blank_Page

Inserts a blank page of the specified size into the Canvas. This can be useful when constructing documents, where you need to insert constructed pages created with the drawing or markup APIs.

Prototype

IGR_LONG IGR_Canvas_Blank_Page(
    HCANVAS canvas,
    const IGR_UCS2* options,
    IGR_LONG width,
    IGR_LONG height,
    Error_Control_Block* error);

Parameters

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Options: const IGR_UCS2*

Option string providing any extended processing options.

Width: IGR_LONG

Width of the page to insert, in pixels.

Height: IGR_LONG

Height of the page to insert, in pixels.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

Return value

Success: LONG

Returns IGR_OK.

Failure: LONG

Returns one of the possible IGR_E error codes.