Publication 1756-RM004B-EN-P - October 2000
CIP Messaging API 4-25
Special Callback Registration
MVIcip_RegisterFatalFaultRtn
Syntax:
int MVIcip_RegisterFatalFaultRtn(
MVIHANDLE apiHandle,
MVICALLBACK (*fatalfault_proc)( ) );
Parameters:
apihandle handle returned by previous call to MVIcip_Open
fatalfault_proc pointer to fatal fault callback routine
Description:
This function is used by an application to register a fatal fault callback
routine. Once registered, the backplane device driver will call
fatalfault_proc
if a fatal fault condition is detected.
apiHandle
must be a valid handle returned from MVIcip_Open.
fatalfault_proc
must be a pointer to a fatal fault callback function.
A fatal fault condition will result in the module being taken offline; i.e.,
all backplane communications will halt. The application may register a
fatal fault callback in order to perform recovery, safe-state, or diagnostic
actions.
Return Value:
MVI_SUCCESS routine was registered successfully
MVI_ERR_NOACCESS
apihandle
does not have access
Example:
MVIHANDLE apihandle;
// Register a fatal fault handler
MVIcip_RegisterFatalFaultRtn(apiHandle, fatalfault_proc);
See Also:
fatalfault_proc