IGR_Enum_Bookmarks¶

Enumerate all bookmarks, up-to recurse_depth, to an application-defined callback function.

Prototype¶

C/C++

IGR_RETURN_CODE IGR_Enum_Bookmarks(
    IGR_LONG docHandle,
    const struct IGR_Bookmark* root,
    IGR_LONG recurse_depth,
    IGR_CALLBACK_BOOKMARK callback,
    void* context,
    Error_Control_Block* error
)

Parameters¶

docHandle: IGR_LONG

Handle to a HD document.

root: Pointer to IGR_Bookmark

Optional bookmark value to enumerate, or NULL to enumerate from root.

recurse_depth: IGR_LONG

Maximum depth to scan.

callback: IGR_CALLBACK_BOOKMARK

A pointer to an application-defined callback function.

context: Pointer to void

An application-defined value to be passed to the callback function.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

Return value¶

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.