IGR_Open_DDB¶

Opens a document from an OS based, device-dependant bitmap (Windows-Only).

Prototype¶

IGR_RETURN_CODE IGR_Open_DDB(
    void* bitmap,
    void* palette,
    IGR_LONG flags,
    const IGR_UCS2* options,
    IGR_LONG* capabilities,
    IGR_LONG* file_type,
    IGR_LONG* handle,
    Error_Control_Block* error
)

Parameters¶

bitmap: Pointer to void

Provide a handle to the OS bitmap (HBITMAP).

palette: Pointer to void

Provide a handle to an optional OS palette (HPALETTE).

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: Pointer to IGR_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.

file_type: Pointer to IGR_LONG

Returns the Document Format Code of the document.

handle: Pointer to IGR_LONG

Returns a handle to be used in subsequent calls.

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.