IGR_Canvas_Bookmarks_Append¶

Append a single bookmark to the canvas. Bookmarks are added one at a time and the level parameter in the IGR_Bookmark determines the hierarchy. Bookmarks in a hierarchy must be added in order and a bookmark’s level cannot be more than one more level deep than the previous bookmark.

Prototype¶

C/C++

IGR_LONG IGR_Canvas_Bookmarks_Append (
    HCANVAS canvas,
    const struct IGR_Bookmark* bookmark,
    Error_Control_Block* error);

Parameters¶

Canvas: HCANVAS

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

Bookmark: Pointer to IGR_Bookmark

Pointer to bookmark data to add.

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.