|
DTWAIN_GetErrorString |
Top Previous Next |
|
The DTWAIN_GetErrorString function returns a meaningful error message string
LONG DTWAIN_GetErrorString (
Parameters 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. This argument is ignored if szBuffer is NULL.
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.
Character specific version
Comments The DTWAIN_GetErrorString function fills in szBuffer with a meaningful error message associated with the error ErrNum. Maxlen is the number of characters of the error message that will be copied to szBuffer, including the terminating null character.
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.
TWAIN State Transitions None
Prerequisite Calls None.
Character specific version ANSI version: DTWAIN_GetErrorStringA Unicode version: DTWAIN_GetErrorStringW
See Also |