Overview

Used to return error messages from the C API.

The IGR_Annotation structure is used by the IGR_Get_Page_Annotations, IGR_Get_Page_Annotation_Long, and IGR_Get_Page_Annotation_Str methods to return information such as annotation type, position, and dimensions for annotations on a given page.

The IGR_Bookmark structure is used by the IGR_Get_Bookmarks_Root method to return information about the hierarchical navigation of a document.

The IGR_CALLBACK data type represents the function signature of a callback from Document Filters.

Context structure for the callback functions used in document comparison.

Structure representing a difference between compared documents.

Structure representing a difference item in a compared document.

Structure representing a rectangle with floating-point coordinates. The coordinates are defined by the left, top, right, and bottom edges.

The IGR_Hyperlink structure is used by the IGR_Get_Page_Hyperlinks method to return information such as position and destination for hyperlinks on a given page.

The IGR_OPEN_CALLBACK data type represents the function signature of a callback passed to IGR_Open_Ex.

The IGR_Open_Callback_Action_Heartbeat structure is the payload argument for IGR_OPEN_CALLBACK when the action argument is IGR_OPEN_CALLBACK_ACTION_HEARTBEAT.

The IGR_Open_Callback_Action_Localize structure is the payload argument for IGR_OPEN_CALLBACK when the action argument is IGR_OPEN_CALLBACK_ACTION_LOCALIZE.

The IGR_Open_Callback_Action_Password structure is the payload argument for IGR_OPEN_CALLBACK when the action argument is IGR_OPEN_CALLBACK_ACTION_PASSWORD.

Structure representing information about an open Device Independent Bitmap (DIB). It includes details such as size, flags, width, height, stride, pixel format, pixel data, palette information, and palette count.

IGR_Open_DIB_Info is used by IGR_Get_Page_Elements and related functions to enumerate the elements on a page.

The IGR_Page_Form_Element structure is used by the IGR_Get_Page_Form_Elements method to return information such as position, dimensions, and text about the form items on a given page.

The IGR_Page_Pixels structure is used by IGR_Get_Page_Pixels to retrieve the pixel data for a given page.

The IGR_Page_Word structure is used by the IGR_Get_Page_Words method to return information such as position, dimensions, and text about the words on a given page.

The IGR_Rect structure is used to specify the position of a rectangle.

The IGR_Render_Page_Form_Values structure is used within IGR_Render_Page_Properties to specify new values for form values.

The IGR_Render_Page_Properties structure is used by the IGR_Render_Page_Ex method and provides additional information for rendering a page to a canvas.

Structure representing a redaction area for rendering on a page. The redaction area is defined by its position (x, y) and size (width, height), along with the color to use for rendering and additional reserved data.

Structure representing a rectangle with signed integer coordinates. The coordinates are defined by the left, top, right, and bottom edges.

The IGR_Size structure is used to specify the size of a rectangle.

The IGR_Stream data type allows for the creation of custom input streams.

Used to return subfile information from the IGR_Get_Subfile_Entry_Ex C API.

When a second or later part of a multi-part archive is required as part of processing an Extended Stream, a callback will request this structure to be populated with a new stream instance.

Structure representing a source document for text comparison.

Settings structure for text comparison operations.

Similar to the IGR_Stream, the IGR_Writable_Stream data type allows for the creation of custom output streams. It’s important to note, all methods must be implemented, not just the Write.

The Instance_Status_Block data type is a control block returned by Init_Instance with information about the installed Document Filters engine.