Rockwell Automation Publication 1756-UM003C-EN-P - April 2018 5
Table of Contents
Chapter 5
Backplane API Library Functions Initialization Function Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
OCXcip_Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
OCXcip_OpenNB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
OCXcip_Close. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Object Registration Function Category . . . . . . . . . . . . . . . . . . . . . . . . . 59
OCXcip_RegisterAssemblyObj. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
OCXcip_UnregisterAssemblyObj . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Special Callback Registration Function Category . . . . . . . . . . . . . . . . 61
OCXcip_RegisterFatalFaultRtn . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
OCXcip_RegisterResetReqRtn. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Connected Data Transfer Function Category. . . . . . . . . . . . . . . . . . . . 62
OCXcip_Write Connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
OCXcip_ReadConnected. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
OCXcip_ImmediateOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
OCXcip_WaitForRxData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
OCXcip_WriteConnectedImmediate. . . . . . . . . . . . . . . . . . . . . . . 65
Tag Access Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
OCXcip_AccessTagData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
OCXcip_AccessTagDataAbortable . . . . . . . . . . . . . . . . . . . . . . . . . 68
OCXcip_CreateTagDbHandle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
OCXcip_DeleteTagDbHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
OCXcip_SetTagDbOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
OCXcip_BuildTagDb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
OCXcip_TestTagDbVer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
OCXcip_GetSymbolInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
OCXcip_GetStructInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
OCXcip_GetStructMbrInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
OCXcip_GetTagDbTagInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
OCXcip_AccessTagDataDb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
OCXcip_SetTagAccessConnSize . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Messaging Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
OCXcip_GetDeviceIdObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
OCXcip_GetDeviceICPObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
OCXcip_GetDeviceIdStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
OCXcip_GetExDevObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
OCXcip_GetWCTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
OCXcip_SetWCTime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
OCXcip_GetWCTimeUTC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
OCXcip_SetWCTimeUTC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
OCXcip_PLC5TypedRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
OCXcip_PLC5TypedWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
OCXcip_PLC5WordRangeWrite . . . . . . . . . . . . . . . . . . . . . . . . . . 95
OCXcip_PLC5WordRangeRead . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
OCXcip_PLC5ReadModWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
OCXcip_SLCProtTypedRead. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
OCXcip_SLCProtTypedWrite. . . . . . . . . . . . . . . . . . . . . . . . . . . . 101