OCR_GetInputFieldByIndex

<< Click to Display Table of Contents >>

Navigation:  OCR Module > Input List Handling >

OCR_GetInputFieldByIndex


 

PRO SDK Icon OCR_GetInputFieldByIndex

 


 

OCR_GetInputFieldByIndex returns the zero-indexed PXO_InputField currently stored in its InFields structure. I.e. the current OCR settings. Please note that all elements are case-sensitive:

 

HRESULT OCR_GetInputFieldByIndex(

PXO_InputFields InFields,

DWORD nIndex,

PXO_InputField *InField

);

 

Parameters

 

InFields

The PXO_InputFields variable that OCR_NewInputFields created.

 

nIndex

The zero-based index of the field to retrieve from InFields.

 

InField

This parameter is a pointer to the structure that the requested input field will fill. All BSTR members are copies of the internal data and SysFreeString () must be used to deallocate them. (N.b. this will not impact the internally stored strings that are associated with the input field).

 

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.