DTWAIN_GetOCRProductFamily

 Top  Previous  Next

The DTWAIN_GetOCRProductFamily gets an OCR engine's product family name.

 

LONG DTWAIN_GetOCRProductFamily (

DTWAIN_OCRENGINE

Engine,

LPTSTR

szBuffer,

LONG

MaxLen );

 

Parameters

Engine

Specifies an OCR engine.

 

szBuffer

Specifies the address of the character buffer to store the product name or NULL.

 

MaxLen

Specifies the maximum number of characters to copy to szBuffer.

 

 

Return Values

If the function succeeds, the number of characters copied to szBuffer is returned.  If the function fails, DTWAIN_FAILURE1 is returned.

 

Character specific version

ANSI version:

DTWAIN_GetOCRProductFamilyA

Unicode version:

DTWAIN_GetOCRProductFamilyW

 

Comments

The DTWAIN_GetOCRProductFamily function fills szBuffer with the ProductFamily associated with the OCR engine Engine. The MaxLen argument is the maximum number of characters to copy to szBuffer, including the trailing null character.

 

If szBuffer is NULL, the length of the ProductFamily's name is returned only.   The returned length includes the length of the name, plus one for the terminating NULL character.  You can use this method to determine the total number of characters needed to store the entire name.

 

TWAIN State Transitions

None.

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

DTWAIN_InitOCRInterface

DTWAIN_EnumOCRInterfaces, or DTWAIN_SelectOCREngine, or DTWAIN_SelectOCREngineByName, or DTWAIN_SelectDefaultOCREngine