IGR_Extract_Page_Image¶

IGR_Extract_Page_Image extracts the embedded image referenced by id to the file specified by destination.

Prototype¶

IGR_RETURN_CODE IGR_Extract_Page_Image(
    HPAGE pageHandle,
    const IGR_UCS2* id,
    const IGR_UCS2* destination,
    Error_Control_Block* error
)

Parameters¶

pageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

id: Pointer to IGR_UCS2

Unique ID of the sub-document to be extracted, obtained by a call to IGR_Get_Image_Entry.

destination: Pointer to IGR_UCS2

Path to a file on disk, where the binary the sub-document will be written.

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.

See Also¶