SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetLastFunctionStatus
extern SE_Return_Code
SE_GetLastFunctionStatus
(
SE_Store store,1
SE_Status_Code *last_function_status,2
SE_String *status_description3
);

Definition

This function provides a user of the SEDRIS API with additional status information for the last function called by that user prior to the invocation of this function; this information is in the form of an SE_Status_Code (last_function_status) accompanied by an elaborating textual description (status_description).

This additional status information is available only for the last function invoked. Upon the next call to the API, the internal status information returned by SE_GetLastFunctionStatus() will then be updated to refer to that function, regardless of its SE_Return_Code.


Returns

SE_RETCOD_SUCCESS and the last function information is returned
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set upon successful completion.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_C_STORE_INVALID set if status_description is not NULL but store is not a handle to a valid SE_Store.
SE_STATCODE_INACTIONABLE_FAILURE set if
  1. last_function_status is NULL, or
  2. the call fails for any other reason.

Parameters Notes

1 manages the memory associated by this function with status_description

2 an appropriate SE_Status_Code describing the last function (prior to the invocation of SE_GetLastFunctionStatus()) invoked by the caller.

3 elaborating information (in addition to last_function_status) supplied regarding the last function (prior to the invocation of SE_GetLastFunctionStatus()) invoked by the caller.


Prev: SE_GetIterationLengthRemaining. Next: SE_GetMeshFaceTableData. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS