Sun Java System Messaging Server 6 2005Q4 MTA Developer's Reference

mtaStrError()

Obtain a text description of an error status code.

Syntax


const char *mtaStrError(int code,
                        int item_code);

Arguments

Arguments  

Description  

code

The MTA SDK error status to obtain a text description for. 

item_code

Reserved for future use. A value of zero must be supplied for this call argument. 

Description

Use mtaStrError() to obtain English language descriptions of MTA SDK error codes. These descriptions are intended solely for use in fine-grained diagnostic output. They are not intended for reading by end users of programs written using the MTA SDK.

Return Values

A pointer to a NULL terminated string containing the error code description.

Example


ires = mtaEnqueueStart(&nq, from, 0, 0);
if (ires)
    printf("mtaEnqueueStart() returned %d; %s\n",
           ires, mtaStrError(ires, 0));