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

Definition

This function registers the function specified by user_defined_function as the general callback, to be called when any transmittal function is about to return any status code, unless that function has either a general function callback or a specific callback for that status code currently registered. This user-defined function shall be defined to be defined to be of function data type SE_Status_Logger (see).

The value NULL for user_defined_function indicates that a callback function is not being requested.

A general function single function callback has priority over this general function callback for all functions' callback. See the 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. More details may be found under the SE_SetSpecificCallback() function.


Returns

SE_RETCOD_SUCCESS all operations succeeded.
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_INACTIONABLE_FAILURE set upon failure.

Parameters Notes

1 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 26, 2006 Copyright © 2006 SEDRIS