<< Click to Display Table of Contents >> Navigation:  OCR Module > High-Level Functions > OCR_GetField

---

 

OCR_GetField

 

---

 

OCR_GetField uses the region and parameters specified to perform OCR on the input document, then formats and returns the plain text. Please note that all elements are case-sensitive:

 

HRESULT OCR_GetField(

PXODocument Doc,

PXO_Options* pOptions,

BSTR* bstrTextOut,

PXO_InputField InField,

DWORD Flags=PXO_Origin_BottomLeft

);

 

Parameters

 

Doc

Specifies the PXODocument that OCR_Init created and OCR_LoadW or OCR_LoadA loaded.

 

pOptions

This parameter is an input pointer to a PXO_Options structure that contains the OCR parameters.

 

bstrTextOut

This parameter is a pointer to the BSTR variable that receives the allocated text. SysFreeString() must be used to deallocate text when this process is complete.

 

InField

This parameter is an input PXO_InputField structure that contains an input field/zone definition for OCR.

 

Flags

This is an optional parameter that specifies the coordinate system that input fields use. See PXO_FieldInputFlags for further information.

 

Return Values

 

If the function succeeds then the return value is OCR_OK.

 

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

 

---