AddInLogMessage

Function : AddIn

AddInLogMessage - Format and write a message to the log file (uses string resources).

#include <addin.h>
void LNVARARGS AddInLogMessage(

    STATUS  StringID,
    STATUS  AdditionalErrorCode,
    <Any 'C' type>  optional_var1, ...);

Description :

This function formats a message, displays it on the standard output, and appends the message as new line to the "Events" field in a Miscellaneous Events document in the Domino server or Notes client log. The generated message has the form:

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

The first parameter, StringID, is a resource ID that identifies a string resource located in the calling program's resource module. The second parameter, AdditionalErrorCode, may be another string resource ID, or it may be the STATUS returned from a C API function.

The string specified by StringID may contain up to six printf-type format specifiers. If it does contain printf-type format specifiers, the last remaining parameters must be printf-type arguments that resolve each of the format specifiers. Up to 24 bytes of additional parameters may be specified.
Pointer arguments, such as the addresses of strings, must be "far" pointers.
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.

AddInLogMessage formats the Primary status message using StringID and the last remaining parameters as described above. It formats the Secondary status message using the error message associated with the second parameter, AdditionalErrorCode.

This routine only supports errors that are stored as string resources and therefore is not portable across all types of platforms. Use the function, AddInLogMessageText for platforms that do not support string resources.

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 : StringID - Primary status message string resource ID. The string may contain up to six printf-type (%) format specifiers. For each format specifier, a corresponding argument must be specified after the AdditionalErrorCode argument to resolve the format specifier.

AdditionalErrorCode - Secondary status code or message string resource ID. If not used, specify NOERROR.

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

Output : (routine) - None

Sample Usage :

[from .RC file]
#define MSG_INDEX_DONE PKG_ADDIN+126

[from .RC file, string table]

MSG_INDEX_DONE, "Indexed %lu documents (%lu bytes) in %s"


[from .C file]
if (!error)
{


AddInLogMessage(MSG_INDEX_DONE, NOERROR,
      Stats.DocsAdded + Stats.DocsUpdated + Stats.DocsDeleted,
      Stats.BytesIndexed,
      CTX->FileName);
}