Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

dsmLogEvent

The dsmLogEvent function call logs a user message (ANE4991 I) to the server log file, to the local error log, or to both. A structure of type logInfo is passed in the call. This call must be performed while at InSession state inside a session. Do not perform it within a send, get, or query. See Figure 20. To retrieve messages logged on the server, use the query actlog command through the Administrative Client. See the Tivoli Storage Manager Administrator's Reference for more information.

Syntax

dsInt16_t dsmLogEvent
     (dsUint32_t    dsmHandle,
     logInfo        *logInfoP);

Parameters

dsUint32_t dsmHandle(I)
The handle that associates this call with a previous dsmInitEx call.

logInfo *logInfoP (I)
Passes the message and destination. The application client is responsible for allocating storage for the structure.

The fields in the logInfo structure are:

message
The text of the message to be logged. This must be a null-ended string. The maximum length is DSM_MAX_RC_MSG_LENGTH.

dsmLogtype
Specifies where to log the message. Possible values include: logServer, logLocal, logBoth.

Return Codes

The return code numbers are provided in parentheses ( ).

Table 35. Return Codes for dsmLogEvent

Return Code Explanation
DSM_RC_STRING_TOO_LONG (2120) The message string is too long.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]