LogAddNumberItem

Function : Log

LogAddNumberItem - Add a number to a log entry.

#include <log.h>
STATUS LNPUBLIC LogAddNumberItem(

    WORD  LogEntry,
    WORD  Flags,
    char far *ItemName,
    NUMBER far *Number);

Description :

This function takes a log entry number, a lock entry flag, the name of the item, and the NUMBER value you wish to add to the log entry. It deletes any existing item with the same name before adding the new value.

Parameters : Input : LogEntry - A WORD containing the number of the log entry to use.

Flags - A WORD flag that determines how often the log entry is flushed to disk. If LOG_LEAVE_LOCKED is specified, then the log entry is not written to disk until it is completed, to preseve the consistency of the fields in the entry. If 0 is specified (the default), then the partially completed log entry is flushed to disk every so often so that it can be seen in the Log database.

ItemName - A null-terminated item name of the item to be added.

Number - A pointer to a NUMBER containing the number you wish to append to the log entry. The Domino typedefs FLOAT and NUMBER, are synonymous with the standard 'C' language type 'double'.

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

NOERROR - Successfully added number to log entry.

ERR_xxx - Errors returned by lower level functions. There are so many possible causes, that It is best to use the code in a call to OSLoadString and display the error for the user.

Sample Usage :

   if (error_status = LogAddNumberItem(log_entry, LOG_LEAVE_LOCKED,
                         "DaysExecuted", (NUMBER *) &day_double))
       goto Exit;