Name

dce_msg_get_msg − Retrieves a DCE message from its ID

Synopsis

#include <dce/dce_msg.h> unsigned char ∗dce_msg_get_msg(
unsigned32 message,
error_status_t ∗status);

Parameters

Input

messageID of message to be retrieved. 

Output

statusReturns the status code from this operation.  The status code is a value that indicates whether the routine completed successfully and if not, why not. 

Description

The dce_msg_get_msg() routine retrieves the text for a specified message (which is a 32-bit DCE message ID as described in dce_error_inq_text(3dce)).  The routine implicitly determines the correct message catalog in which to access the message, and opens it; the caller only has to call the routine. 

The routine first searches the appropriate message catalog for the message, and then (if it cannot find the catalog) searches the in-memory message table.  If the message cannot be found in either of these places, the routine returns a default string and fills in status with an error code.  This routine thus always returns a string, even if there is an error (except for msg_sno_memory). 

The message, if found, is returned in allocated space to which the routine returns a pointer.  The pointed-to space must be freed by the caller using free().  If memory cannot be allocated, the routine returns NULL and fills in status with the msg_s_no_memory error code. 

Errors

The following describes a partial list of errors that might be returned.  Refer to the OSF DCE Problem Determination Guide for complete descriptions of all error messages. 

See dce_get_msg(3dce). 

Related Information

Functions:  dce_msg_define_msg_table(3dce), dce_msg_get(3dce), dce_msg_get_default_msg(3dce).