ProSoft Technology MVI69-ADM - Manual (Page 279)

MVI-ADM ♦ 'C' Programmable CIP Messaging Library Functions
'C' Programmable Application Development Module Developer's Guide
ProSoft Technology, Inc. Page 279 of 342
February 20, 2013
DWORD lODeviceSn; // Serial number of the originator
WORD iOVendorId; // Vendor Id of the originator
WORD rxDataSize; // size in bytes of receive data
WORD txDataSize; // size in bytes of transmit data
BYTE *configData; // pointer to configuration data sent in open
WORD configSize; // size of configuration data sent in open
WORD *extendederr; // an extended error code if an error occurs
} MVICIPCONNSTRUC;
connHandle identifies this connection. This value must be passed to the
MVIcip_ReadConnected function.
reg_param is the value that was passed to MVIcip_RegisterAssemblyObj. The
application may use this to store an index or pointer. It is not used by the CIP
API.
reason specifies whether the connection is being opened or closed. A value of
MVI_CIP_CONN_OPEN indicates the connection is being opened,
MVI_CIP_CONN_OPEN_COMPLETE indicates the connection has been
successfully opened, and MVI_CIP_CONN_CLOSE indicates the connection is
being closed. If reason is MVI_CIP_CONN_CLOSE, the following parameters are
unused: producerCP, consumerCP, api, rxDataSize, and txDataSize.
instance is the instance number that is passed in the forward open.
Note: This corresponds to the Configuration Instance on the RSLogix 5000 generic profile.
producerCP is the producer connection point from the open request.
Note: This corresponds to the Input Instance on the RSLogix 5000 generic profile.
consumerCP is the consumer connection point from the open request.
Note: This corresponds to the Output Instance on the RSLogix 5000 generic profile.
lOTApi is a pointer to the originator-to-target actual packet interval for this
connection, expressed in microseconds. This is the rate at which connection data
packets will be received from the originator. This value is initialized according to
the requested packet interval from the open request. The application may choose
to reject the connection if the value is not within a predetermined range. If the
connection is rejected, return MVI_CIP_FAILURE and set extendederr to
MVI_CIP_EX_BAD_RPI. Note: The minimum RPI value supported by the MVI56
module is 600us.
lTOApi is a pointer to the target-to-originator actual packet interval for this
connection, expressed in microseconds. This is the rate at which connection data
packets will be transmitted by the module. This value is initialized according to
the requested packet interval from the open request. The application may choose
to increase this value if necessary.
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.