IGR_Get_Page_Text¶
IGR_Get_Page_Text extracts the text of a previously opened page of a document.
Prototype¶
IGR_LONG IGR_Get_Page_Text(
HPAGE PageHandle,
IGR_UCS2* Buffer,
IGR_LONG* Size,
Error_Control_Block* error);
Parameters¶
PageHandle: HPAGE
Handle to a page, opened by a call to IGR_Open_Page.
Buffer: Unicode string (UCS2)
Application allocated memory block that is to be populated with the next portion of text.
Size: Pointer to IGR_LONG
Prior to the call: The size in Unicode characters of the buffer.
After the call: The actual number of Unicode characters extracted.
Error: Pointer to Error_Control_Block
Returns error details if the call fails.
Return value¶
Success: IGR_LONG
Returns IGR_OK.
Success and the end of the document was reached: IGR_LONG
Returns IGR_NO_MORE.
Failure: IGR_LONG
Returns one of the possible IGR_E error codes.
Additional information¶
IGR_Get_Page_Text operates on the same concept as IGR_Get_Text; the caller should keep calling IGR_Get_Page_Text until it returns IGR_E_NO_MORE error.