5cip api functions – ProSoft Technology MVI56E-LDM User Manual
Page 76

CIP API Functions
ControlLogix Platform ♦ "C" Programmable
Developer's Manual
Linux Application Development Module
Page 70 of 264
ProSoft Technology, Inc.
March 12, 2014
5
CIP API Functions
In This Chapter
CIP API Initialization Functions .............................................................. 73
Object Registration ................................................................................ 79
Special Callback Registration ................................................................ 84
Connected Data Transfer ...................................................................... 99
Tag Access Functions ......................................................................... 110
Messaging ........................................................................................... 138
Miscellaneous Functions ..................................................................... 166
The following table lists the CIP API Library functions. Details of each function
follow in subsequent sections:
Function Category
Function
Initialization
OCXcip_Open
- Starts the backplane engine and initializes access to the CIP
API.
OCXcip_OpenNB
- Allows access without opening backplane access.
OCXcip_Close
- Terminates access to the CIP API.
Object Registration
OCXcip_RegisterAssemblyObj
- Registers all instances of the Assembly
Object, enabling other devices in the CIP system to establish connections with
the object. Callbacks are used to handle connection and service requests.
OCXcip_UnregisterAsssemblyObj
- Unregisters all instances of the
Assembly Object that had previously been registered. Subsequent connection
requests to the object are refused.
Callback Registration
OCXcip_RegisterFatalFaultRtn
- Registers a fatal fault handler routine.
OCXcip_RegisterResetReqRtn
- Registers a reset request handler routine.
Connected Data Transfer
OCXcip_WriteConnected
- Writes data to a connection.
OCXcip_ReadConnected
- Reads data from a connection.
OCXcip_WaitForRxData
- Blocks until new data is received on connection.
OCXcip_ImmediateOutput
- Transmit output data immediately.
OCXcip_WriteConnectedImmediate
- Update and transmit output data
immediately.