SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE SetGeneralCallback
extern SE_Return_Code
SE_SetGeneralCallback
(
SE_Error_Handling_Function_Ptr user_defined_function (notes)
);

Definition

Registers a user-defined function as the general callback, to be called when any Level 0 API function is about to return any function code, unless that function has either a general function callback or a specific callback for that status code currently registered. A general function (general single function) callback has priority over this general (general for all functions) callback. See the SE_SetGeneralCallbackForOneFunction() function comments for more details about general function callbacks. A specific function/specific status code callback has priority over both general function callbacks and over general callbacks. See the SE_SetSpecificCallback() function comments for more details.

The user-defined function for the General Callback must be defined to match SE_Error_Handling_Function_Signature.


Returns

SE_RET_CODE_SUCCESS all operations succeeded.
SE_RET_CODE_FAILUREand the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS set upon successful completion.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set upon failure.


Parameters Notes


user_defined_function

 a pointer to a user-defined callback
    function to be registered as the General Callback function.  If NULL,
    then this 'clears' the General Callback capability.


Prev: SE_SetFirstErrorMessage. Next: SE_SetGeneralCallbackForOneFunction. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS