SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE SetGeneralCallbackForOneFunction
extern SE_Return_Code
SE_SetGeneralCallbackForOneFunction
(
SE_Status_Logger_Ptr user_defined_function,1
SE_API_Function function_to_catch2
);

Definition

Registers a user-defined function as the 'callback' function to be called when any status code is about to be returned by the given Level 0 API function. This user-defined function must be defined to match SE_Status_Logger.

This callback will not be called if a specific status code is about to be returned from the selected Level 0 API function and that particular function and status code currently have a specific function/specific status code callback set by the SE_SetSpecificCallback() function. A specific function/specific status code callback set by that call takes priority over a general function callback set by this call.

See the comments of SE_SetSpecificCallback() for more details.


Returns

SE_RETCOD_SUCCESS and the callback is set.
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 if valid parameters were passed in and the call was successful.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE set if function_to_catch was invalid or the call fails for any other reason.

Parameters Notes

1 a pointer to a user-defined callback function. If NULL, then this 'clears' the general callback capability for that function.

2 the specific function for which user_defined_function is to be a general callback.


Prev: SE_SetGeneralCallback. Next: SE_SetRootObject. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS