<< Click to Display Table of Contents >> Navigation:  OCR Module > Low-Level Functions > OCRp_GetRegionFromPage

---

 

OCRp_GetRegionFromPage

 

---

 

OCRp_GetRegionFromPage returns a requested output region from the specified PXO_Page object. Please note that all elements are case-sensitive:

 

HRESULT OCRp_GetRegionFromPage(

PXO_Page PageResults,

ULONG nRegion,

PXO_Region *pRegionResults,

 

);

 

Parameters

 

PageResults

Specifies the PXO_Page object that contains the region to retrieve.

 

nRegion

This parameter is a zero-based index that specifies the region number to retrieve. The maximum value is one integer less than the region count that OCRp_RegionCountFromPage returns.

 

pRegionResults

This parameter is a pointer to the PXO_Region structure that will contain the results of the retrieved region.

 

Please note that regions are internally linked to their parent PXO_Page. A call to OCRp_FreePage on the parent region will free the memory that retrieved regions use and invalidate them.

 

Return Values

 

If the function succeeds then the return value is DS_OK.

 

If the function fails then the return value is an error code.

 

---