dsmLogEventEx

Edit online

The dsmLogEventEx function call logs a user message to the server log file, to the local error log, or to both. This call must be made while at an InSession state within a session. The call cannot be made within a send, get, or query call.

Summary state diagram: For an overview of the session interactions, see the summary state diagram in the following topic:

Figure 1

The severity determines the IBM® Storage Protect message number. To view messages that are logged on the server, use the query actlog command through the administrative client. Use the IBM Storage Protect client option, errorlogretention, to prune the client error log file if the application generates numerous client messages written to the client log, dsmLogType either logLocal or logBoth. For more information, see the IBM Storage Protect server documentation.

Syntax

extern dsInt16_t DSMLINKAGE  dsmLogEventEx(
       dsUint32_t            dsmHandle,
       dsmLogExIn_t          *dsmLogExInP,
       dsmLogExOut_t         *dsmLogExOutP
);

Parameters

dsUint32_t dsmHandle(I)

The handle that associates this call with a previous dsmInitEx call.

dsmLogExIn_t *dsmLogExInP

This structure contains the input parameters.

dsmLogSeverity severity;

This parameter is the event severity. The possible values are:

   logSevInfo,       /* information ANE4990 */
   logSevWarning,    /* warning     ANE4991 */
   logSevError,      /* Error       ANE4992 */
   logSevSevere      /* severe      ANE4993 */

char appMsgID[8];

This parameter is a string to identify the specific application message. A suitable format is three characters that are followed by four numbers, for example: DSM0250.

dsmLogType logType;

This parameter specifies where to direct the event. The parameter has the following possible values:

logServer
logLocal
logBoth

char *message;

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

Restriction: Messages that go to the server must be in English. Non-English messages do not display correctly.

dsmLogExOut_t *dsmLogExOutP

This structure contains the output parameters. Currently, there are no output parameters.

Return codes

The return code numbers are provided in parentheses ( ).

Table 1. Return codes for dsmLogEventEx
Return code	Explanation
`DSM_RC_STRING_TOO_LONG (2120)`	The message string is too long.