Special callback registration – ProSoft Technology MVI56E-LDM User Manual
Page 90

CIP API Functions
ControlLogix Platform ♦ "C" Programmable
Developer's Manual
Linux Application Development Module
Page 84 of 264
ProSoft Technology, Inc.
March 12, 2014
5.3
Special Callback Registration
OCXcip_RegisterFatalFaultRtn
Syntax
int OCXcip_RegisterFatalFaultRtn(OCXHANDLE apihandle,
OCXCALLBACK (*fatalfault_proc)( ) );
Parameters
apihandle
handle returned by previous call to OCXcip_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
OCXcip_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; that is, 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
OCX_SUCCESS
routine was registered successfully
OCX_ERR_NOACCESS
handle does not have access
Example
OCXHANDLE apihandle;
// Register a fatal fault handler
OCXcip_RegisterFatalFaultRtn(apihandle, fatalfault_proc);
See Also
fatalfault_proc