APCR gate, ESTIMATE_CHANGED function

The ESTIMATE_CHANGED function of the APCR gate is used to obtain the size of the channel data structure that will be used to ship the containers that have been modified since the IMPORT_ALL call. Only new, modified, or deleted containers are shipped, with deleted containers being shipped as container headers only.

Input Parameters

CHANNEL_TOKEN
is a token referencing the channel.
COMMAND
is the type of API command that caused the channel to be shipped.
Values for the parameter are:
  • LINK
  • RETURN
  • START_ISC
  • START_MRO
CONTAINER_LIST
is a list of all the containers in the channel, obtained from an earlier IMPORT_ALL call.

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • CHANNEL_ERROR
BYTES_NEEDED
is the total size, in bytes, of the exported channel, including channel and container headers and the overall length of the data in the containers. This total includes all bytes for all containers.
NEW_CONTAINER_LIST
is a list of all the containers in the channel that have been created, modified, or deleted since the last IMPORT_ALL call. This list must be passed to a subsequent EXPORT_CHANGED call.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_APCRestimate_changed.html | Timestamp icon Last updated: Monday, 5 June 2017