Rockwell Automation Allen-Bradley ControlLogix 1756-MVI - Page 68

Publication 1756-RM004B-EN-P - October 2000
4-16 CIP Messaging API
lODeviceSn is the serial number of the originating device, and
iOVendorId is the vendor ID. The combination of vendor ID and serial
number is guaranteed to be unique, and may be used to identify the
source of the connection request. This is important when connection
requests may be originated by multiple devices.
rxDataSize is the size in bytes of the data to be received on this
connection.
txDataSize is the size in bytes of the data to be sent on this
connection.
configData is a pointer to a buffer containing any configuration data
that was sent with the open request.
configSize is the size in bytes of
the configuration data.
extendederr is a pointer to a word which may be set by the callback
function to an extended error code if the connection open request is
refused.
Return Value:
The connect_proc routine must return one of the following values if
reason is MVI_CIP_CONN_OPEN:
Note: If reason is MVI_CIP_CONN_OPEN_COMPLETE or
MVI_CIP_CONN_CLOSE, the return value must be MVI_SUCCESS.
MVI_SUCCESS connection is accepted
MVI_CIP_BAD_INSTANCE
instance is invalid
MVI_CIP_NO_RESOURCE unable to support connection due to
resource limitations
MVI_CIP_FAILURE connection is rejected –
extendederr may
be set
Extended Error Codes:
If the open request is rejected, extendederr can be set to one of the
following values:
MVI_CIP_EX_CONNECTION_USED The requested connection is
already in use.
MVI_CIP_EX_BAD_RPI The requested packet interval
cannot be supported.
MVI_CIP_EX_BAD_SIZE The requested connection sizes do
not match the allowed sizes.
connect_proc