Using the Application Program Interface

dsmRCMsg

Use dsmRCMsg to get the message text that is associated with an ADSM API return code.

The msg parameter displays the message prefix return code in parentheses, followed by the message text. For example, a call to dsmRCMsg might return the following:

ANS0264E (RC2300) Only root user can execute dsmChangePW or dsmDeleteFS.

Syntax

dsInt16 dsmRCMsg  (dsUint32       dsmHandle,
   dsInt16        dsmRC,
   char        *msg);

Parameters

dsUint32 dsmHandle (I)

This parameter is the handle that associates this call with a previous dsmInit call.

dsInt16 dsmRC (I)

This parameter is the ADSM API return code for which you want the associated message text. The API return codes are listed in the file dsmrc.h (see Appendix C. "API Return Codes Source File").

char *msg (O)

This parameter is the message text that is associated with the return code dsmRC. The caller is responsible for allocating enough space for the message text.

The maximum length for msg is defined as DSM_MAX_RC_MSG_LENGTH.

On platforms that have National Language Support and a choice of language message files, the API will return a message string in the national language.

Return Codes

Figure 41. Return Codes for dsmRCMsg

Return Code	Explanation
DSM_RC_NULL_MSG (2002)	msg parameter for dsmRCMsg call is a NULL pointer.
DSM_RC_INVALID_RETCODE (2021)	Return code passed to dsmRCMsg call is an invalid one.