NAME

dce_error_inq_text - Returns the message text for a DCE component status code

Used by client, server, or management applications. 

Any DCE component, not only RPC, can call this routine. 

SYNOPSIS

#include <dce/rpc.h>
#include <dce/dce_error.h>
void dce_error_inq_text(

unsigned long status_to_convert ,
unsigned char ∗error_text ,
int ∗status );

PARAMETERS

Input

status_to_convert
Specifies the status code to convert to a text string.

Output

error_textReturns a null-terminated character string message corresponding to the status_to_convert argument. 

statusReturns the status code from this routine.  This status code indicates whether the routine completed successfully or, if not, why not.  The possible status codes and their meanings are as follows:

0Success. 

-1Failure. 

DESCRIPTION

The dce_error_inq_text routine returns a null-terminated character-string message for the status code specified. 

The application must provide memory for the returned message.  The largest returned message is dce_c_error_string_len characters long, including the terminating null character. 

If the call fails, this routine returns a message as well as a failure code in the status argument. 

Before calling this routine, the environment variable NLSPATH must be set to point to message catalog files.  A general C-shell command to set this environment variable follows. 

$ setenv NLSPATH <dceshared>/nls/msg/LANG/%N

Note that LANG is a variable instead of a literal.  A specific example of this general command follows. 

$ setenv NLSPATH /usr/lib/nls/msg/en_US.88591/%N

RETURN VALUES

None. 

RELATED INFORMATION

None.