SE GetErrorDescription

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetErrorDescription

extern SE_Status_Code
SE_GetErrorDescription
(
char	*	*	error_description	(notes)
);

Definition

This function is intended to provide the user of the SEDRIS API additional information regarding a failed function call to the SEDRIS API. This function can be called immediately after a non-successful API call to get a verbose description of why the SEDRIS function failed.

The contents of the error description may be over-written by the next SEDRIS API call.

Returns

SE_STAT_CODE_FAILURE

SE_STAT_CODE_SUCCESS and the output parameters provided were set to the appropriate values, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and none of the output parameters are modified, if error_description is NULL.

and none of the output parameters are modified, if there is no valid error message for the last API function called.

Parameters Notes

error_description

 a pointer to a character array. The API creates the
    memory and sets the contents of it. This pointer may be overwritten by
    the next call to the API.

SE_STAT_CODE_SUCCESS	and the output parameters provided were set to the appropriate values, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and none of the output parameters are modified, if error_description is NULL.
and none of the output parameters are modified, if there is no valid error message for the last API function called.