DTWAIN_LogMessage

Top  Previous  Next

The DTWAIN_LogMessage writes a message to the DTWAIN log.

 

DTWAIN_BOOL DTWAIN_LogMessage( LPCTSTR lpszMessage );

 

 

Parameters

lpszMessage

Null-terminated message to write to the DTWAIN log.

 

Return Values

If the function succeeds, TRUE is returned.  If the function fails FALSE is returned.

 

Character specific version

ANSI version:

DTWAIN_LogMessageA

Unicode version:

DTWAIN_LogMessageW

 

Comments

The DTWAIN_LogMessage allows a program to write a message to the DTWAIN log.  The log is initiated by calling DTWAIN_SetTwainLog.

 

The user-defined message can be of any length, but must be null terminated.  When logging this message, DTWAIN will write [User] in the log next to the message, denoting that the message is a user-defined message.  The DTWAIN_LogMessage function is useful if you want to generate your own logging, and include your logging messages within the general DTWAIN logging mechanism.

 

 

Prerequisite Function Call(s)

DTWAIN_SysInitialize

 

DTWAIN Source Selection Function

 

See Also

Opening / Closing a Source