cwbSV_GetErrLibName

Use the cwbSV_GetErrLibName API with this product.

Purpose

Returns the message file library name for the top-level (i.e. most recent) message added to the error handle provided. This message attribute only pertains to IBM i returned messages. The library name is the name of the IBM i library containing the message file for the message.

Syntax

 
unsigned int CWB_ENTRY cwbSV_GetErrLibName(
                             cwbSV_ErrHandle  errorHandle,
                             char            *libraryName,
                             unsigned long    libraryNameLength,
                             unsigned long   *returnLength);

Parameters

cwbSV_ErrHandle errorHandle - input: Handle that was returned by a previous call to the cwbSV_CreateErrHandle() API.
char * libraryName - input/output: Pointer to a buffer that will receive the message file library name stored in the error identified by the handle. The value returned is an ASCIIZ string.
unsigned long libraryNameLength - input: Length of the receive buffer passed in. It should include space for the terminating null character. If the buffer is too small, the value will be truncated and CWB_BUFFER_OVERFLOW and returnLength will be set. NOTE: The recommended size is CWBSV_MAX_MSGFILE_LIBR.
unsigned long * returnLength - input/output: Optional, may be NULL. A return address to store the number of bytes needed to hold the output string if the receive buffer is too small.

Return Codes

The following list shows common return values.

CWB_OK: Successful completion.
CWB_BUFFER_OVERFLOW: Output buffer too small, data truncated.
CWB_INVALID_POINTER: NULL passed on output parameter.
CWB_INVALID_HANDLE: Invalid handle.
CWBSV_NO_ERROR_MESSAGES: No messages are in the error handle.
CWBSV_ATTRIBUTE_NOT_SET: Attribute not set in current message.

Usage

IBM i messages may be added to the error handle when using the cwbRC_CallPgm() and cwbRC_RunCmd() API's. In these cases, you can use this API to retrieve the message file library name for the IBM i messages contained in the error handle. If there is no message file library name attribute for the message, return code CWBSV_ATTRIBUTE_NOT_SET will be returned.