IGR_Open_DIB¶
IGR_Open_DIB opens a document for content extraction or enumeration of sub-documents from an existing in-memory image.
Prototype¶
IGR_LONG IGR_Open_DIB(
const struct IGR_Open_DIB_Info* bitmap,
IGR_LONG flags,
const IGR_UCS2* options,
IGR_LONG* capabilities,
IGR_LONG* file_type,
IGR_LONG* handle,
Error_Control_Block* error);
Parameters¶
Bitmap: const struct IGR_Open_DIB_Info
Pointer to a caller-provided IGR_Open_DIB_Info structure that contains details on how to decode the in-memory image.
Flags: IGR_LONG
Specifies what type of data is returned from subsequent calls to the IGR_Get_Text function. These Open Document Flags affect the verbosity or the format of the extracted data.
Options: Unicode string (UCS2)
Extended processing options, used when converting the document to HTML. The Open Document Options are expressed as Name=Value with a semicolon delimiter.
Capabilities: Pointer to IGR_LONG
Returns the Document Capabilities as a bit field.
DocType: Pointer to IGR_LONG
Returns the Document Format Code of the document.
DocHandle: Pointer to IGR_LONG
Returns a handle to be used in subsequent calls.
ISYSError: 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.