DTL_CIP_APPLICATION_REGISTER parameters

reg_id

is a pointer to a location in which the DTL_CIP_APPLICATION_REGISTER function will place a handle for the application to use in subsequent references to the registration. This

reg_id

will be the instance number of the Software Registration Object that RSLinx Classic creates.

reg_param

is a value which will be passed back to the application as a parameter in the

service_proc

and

connect_proc

callback functions whenever they are called for the registration. The application may use this to store an index, pointer, or handle. It is uninterpreted by the RSLinx Classic software.

cip_id

is a pointer to a structure containing attributes of the registering application in the format of a CIP Identity Object (see CIP Identity Structure). RSLinx Classic maintains an Identity Object for each registered application so that other devices in a CIP system can recognize the presence of the application and gain some information about it. If the

cip_id

pointer is NULL, the only information obtainable by other devices in the CIP system will be that some indeterminate application has been registered. This Object is provided solely for information-gathering purposes. Any CIP connections originated by the application will use the Vendor ID and Originator Serial Number of RSLinx Classic, not the Vendor ID and Serial Number specified by the application for its own Identity Object.

address

is a number to be used as the link address in a path segment by other devices in the CIP system wanting to send messages or open connections to the application. (The path segment should specify Port 1.) This number must be a decimal number from 64 to 254.

name

is a pointer to a buffer containing an International String symbol to be used in a symbolic segment by other devices in the CIP system wanting to send messages or open connections to the application. The number of characters in the string is specified by the

name_len

parameter, and the character format is specified by the

name_fmt

parameter.

name_len

is the number of characters contained in the application's

name

. The number of characters may not exceed 31.

name_fmt

specifies the format of the characters in the application's

name

. Any of the following values is permitted:

service_proc

is a function (of type DTL_CIP_APPLICATION_SERVICE_PROC) in the calling application that will be called whenever a service request is sent to the application. If the application does not specify a callback function, then it will not be able to receive messages.

connect_proc

is a function (of type DTL_CIP_APPLICATION_CONNECT_PROC) in the calling application which will be called whenever a request is made to open a connection with the application. If the application does not specify a callback function, then it will not be able to accept connections.

timeout

is the maximum time (in milliseconds) to wait for the registration to be established.