DTWAIN_GetOCRErrorString

The DTWAIN_GetOCRErrorString function returns a meaningful error message string given an OCR error code.

LONG DTWAIN_GetOCRErrorString (

DTWAIN_OCRENGINE	Engine,
LONG	ErrNum,
LPTSTR	szBuffer,
LONG	MaxLen );

Parameters

Engine

A selected OCR engine

ErrNum

Specifies a DTWAIN error code.

szBuffer

Specifies the address of the character buffer to store the error string, or NULL.

MaxLen

Specifies the maximum number of characters to copy to szBuffer.

Return Values

If the function succeeds, the length of the string stored in szBuffer, or if szBuffer is NULL, the length of the string required to store the entire error message. If the function fails, DTWAIN_FAILURE1 is returned.

If szBuffer is NULL, then the MaxLen argument is ignored, and the return value is the number of characters required to store the entire error string, including the terminating NULL character. No characters are copied to szBuffer if szBuffer is NULL.

Character specific version

ANSI version:	DTWAIN_GetOCRErrorStringA
Unicode version:	DTWAIN_GetOCRErrorStringW

Comments

The DTWAIN_GetOCRErrorString

The error message will be specific for the OCR engine, Engine, that is selected.

TWAIN State Transitions

None

Prerequisite Calls

None.