SE SetGeneralCallbackForOneFunction

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

extern SE_Status_Code
SE_SetGeneralCallbackForOneFunction
(
SE_Error_Handling_Function_Ptr	user_defined_function,	(notes)
SE_Level_0_API_Function	function_to_catch	(notes)
);

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_Error_Handling_Function_Signature.

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_SetCallbackForOneFunctionOneStatusCode() 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_SetCallbackForOneFunctionOneStatusCode() for more details.

Returns

SE_STAT_CODE_SUCCESS and the specified callback is set, if valid parameters were passed in.

SE_STAT_CODE_FAILURE and no changes are made, if function_to_catch was invalid.

Parameters Notes

user_defined_function

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

function_to_catch

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

SE_STAT_CODE_SUCCESS	and the specified callback is set, if valid parameters were passed in.
SE_STAT_CODE_FAILURE	and no changes are made, if function_to_catch was invalid.