PreviousNext

dce_msg_cat_get_msg(3dce)

DCE message text retrieval routine

Synopsis

#include <dce/dce_msg.h>

unsigned char *dce_msg_cat_get_msg(

dce_msg_cat_handle_t handle,

unsigned32 message,

error_status_t *status);

Parameters

Input

message
The ID of the message to be retrieved.

handle
A handle (returned by dce_msg_cat_open( )) to an opened message catalog.

Output

status
Returns 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
Once the catalog has been opened with the dce_msg_cat_open( ) routine, the dce_msg_cat_get_msg( ) routine can be used to retrieve the text for a specified message (which is a 32-bit DCE message ID as described in dce_error_inq_text(3dce)). The space allocated for the message should not be freed. The output pointer is useable until a call to the dce_msg_cat_get_msg( ) or dce_msg_cat_close(~) routine. If the specified message cannot be found in the catalog, the routine returns a NULL and fills in status with the appropriate 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_msg_get(3dce).

Related Information
Functions: dce_msg_cat_close(3dce)

dce_msg_cat_open(3dce)

dce_msg_get_cat_msg(3dce)

dce_msg_get(3dce)

dce_msg_get_msg(3dce)