VMS Help DCE, dce_intro, dce_msg_intro, dce_msg_get_msg *Conan The Librarian (sorry for the slow response - running on an old VAX) |
NAME dce_msg_get_msg - Retrieve 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 message ID of message to be retrieved. 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 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). 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_s_no_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. ERROR CODES See dce_msg_get. RELATED INFORMATION Functions: dce_msg_define_msg_table dce_msg_get dce_msg_get_default_msg
|