Cip Api Functions; Initialization - Rockwell Automation Allen-Bradley ControlLogix 1756-MVI Programming Reference Manual

4-4 CIP Messaging API

CIP API Functions

Function Category

Initialization

Object Registration
Connected Data Transfer
Callback Functions
Special Callback
Registration
Miscellaneous
Publication 1756-RM004B-EN-P - October 2000
The CIP API library functions are listed in table 4.B. Details for each
function are provided in the following sections.
Table 4.B CIP API Library Functions
Function Name
MVIcip_Open
MVIcip_Close
MVIcip_RegisterAssemblyObj
MVIcip_UnregisterAssemblyObj
MVIcip_WriteConnected
MVIcip_ReadConnected
connect_proc
service_proc
rxdata_proc
fatalfault_proc
flashupdate_proc
resetrequest_proc
MVIcip_RegisterReset ReqRtn
MVIcip_RegisterFatalFaultRtn
MVIcip_RegisterFlashUpdateRtn Register a flash update callback routine
MVIcip_GetIdObject
MVIcip_GetVersionInfo
MVIcip_SetUserLED
MVIcip_SetModuleStatus
MVIcip_ErrorString
MVIcip_GetSetupMode
MVIcip_GetConsoleMode
MVIcip_Sleep
Description
Initialize access to the CIP API Initialization
Terminate access to the CIP API
Register 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.
Unregister all instances of the Assembly Object that
had previously been registered. Subsequent
connection requests to the object will be refused.
Write data to a connection
Read data from a connection
Application function called by the CIP API when a
connection request is received for the registered object
Application function called by the CIP API when a
message is received for the registered object
Application function called by the CIP API when data is
received on an open connection
Application function called if the backplane device
driver detects a fatal fault condition
Application function called when flash update is
initiated
Application function called when a module reset
request is received
Register a reset request handler routine
Register a fatal fault handler routine
Return data from the module's Identity Object
Get the CIP API version information
Set the state of a user LED
Set the state of the status LED
Get a text description of an error code
Get the state of the setup jumper
Get the state of the console (programming port PRT1)
Suspend task for specified time