LogEventText

Function : Log

LogEventText - Same as LogEvent, but first argument is a string, not an ID.

#include <log.h>
STATUS LNVARARGS LogEventText(

    char far *String,
    HANDLE  hModule,
    STATUS  AdditionalErrorCode,
    <Any 'C' type>  optional_var1, ...);

Description :

This function does the same thing as LogEvent but it takes a string as the first input parameter rather than the ID of a string in a string table. Use LogEventText instead of LogEvent if your program works in environments where Windows-style resources are not available.

This function formats an error message, displays it on the standard output, and enters it in the Domino Server or Notes client log database. The generated message has the form:

      <DATE>  <TIME>  <Primary status message>: <Secondary status message>

LogEventText is similar to AddInLogErrorText but more flexible. LogEventText uses the second argument, "hModule", to resolve the third argument, "AdditionalErrorCode". If "AdditionalErrorCode" is a non-zero STATUS code returned from a C API function, then you may be able to use AddInLogErrorText.
If "AdditionalErrorCode" is a string in the calling program's resource module, or some other resource module, then "hModule" must specify the module containing that resource.

The first parameter, "String", is the primary status message string. This string may contain printf-type (%) format specifiers. For each format specifier provided, there should be an additional argument provided for output, starting with the fourth argument. The print format specifiers supported by Domino are described in the Tech Note "Domino Print Format Specifiers". Tech Notes are listed in the view, Reference Tools/Tech Notes. The third parameter, "AdditionalErrorCode", may be another string resource ID, or it may be the STATUS returned from a C API function. The second parameter, "hModule", specifies where "AdditionalErrorCode" is resolved. You may specify NULLHANDLE for the second parameter if "AdditionalErrorCode" is resolved by Domino or by the calling program.

When using this function, you should call either AddInIdle or AddInIdleDelay on a regular basis to flush the log entries from memory to disk and free up the memory.

Parameters : Input : String - Primary status message string.

hModule - A module handle of the module containing the string resource identified by error_status. If error_status is a Domino error code, module_handle may be NULLHANDLE.

AdditionalErrorCode - A STATUS code returned by an API function or the string ID of a secondary error message. NOERROR is an acceptable value.

optional_var1, ... - From 0 to 24 bytes of arguments of any type, each corresponding to one of the format specifiers embedded in the string loaded by the first argument. All pointer values must be "far". Leave off this parameter entirely (use only the above 3 arguments) if there are no format specifiers in the Primary status message string.

Output : (routine) - Return status from this call -- indicates either success or what the error is. The return codes include:

NOERROR - Successfully logged the event.

ERR_xxx - Errors returned by lower level functions. Call to OSLoadString to obtain the error message.

Sample Usage :

if (error = LogEventText("Unable to open input file %s.",
        NULLHANDLE, NOERROR, (char far *) szFileName))
   goto Exit;