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

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE

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

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.

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

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™