Overview of the AddContributor Function

The "AddContributor" function adds a contributor to a container. "AddContributor" is called from the contributor. The parameters for the "AddContributor" function are identified below.

HandleName – The name of the handle variable in the container module.

ArrayName – The name of the variable in the ContainerObj parameter (see below) that holds an array of values to which the contributor's value should be added. This parameter may be invalid if there is no such array in the container.

CountName – The name of the variable in the ContainerObj parameter (see below) that holds a count of the current number of this type of contributor. "CountName" may be invalid if no such variable exists in the ContainerObj. Not all contributors need to be counted. The CountIncrement (see below) determines the initial change in the count, and the contributor must maintain the count.

ContainerObj – The object value of the container tag module.

ContributorObj – The object value of the new contributor to add.

IndexAddress – The address of the variable holding the contributor index.

Value – The current value to set in the container's ArrayName array (see above). This value may be invalid, and may be updated at any time by the contributor by scoping into the ArrayName in the container and setting the array element at the index that will be set in the variable pointed to by IndexAddress (see above).

CountIncrement – This value is added to the CountName variable in the container (see above). This value is usually a "0" or a "1", indicating whether or not the contributor is actively contributing its value now. The contributor increments or decrements the value of the CountName variable (see above) as the corresponding state of the contributor changes.

Additional information on the "AddContributor" function can be found in "12: VTS Functions and Statements: AddContributor.