Description: This function removes a contributor from a container.
Returns: Numeric
Usage: Script
Format: DeleteContributor(HandleName, ArrayName, CountName, ContainerObj, ContributorObj, CountIncrement);
Parameters:
HandleName
{ text } { required } { no default
}
The name of the
handle variable in the container module.
ArrayName { text } { required } { no
default }
The name of
the variable in the ContainerObj that holds
an array of values from which to delete the contributor. This parameter may be
invalid if there is no such array in the container.
CountName { text } { required } { no
default }
The name of
the variable in the ContainerObj that holds
a count of the current number of this type of contributor. This parameter may be
invalid if no such variable exists in the ContainerObj. Not all contributors need to be
counted. The CountIncrement determines the
initial change in the count and the contributor must maintain the count.
ContainerObj { Object value } { required
} { no default }
The object value of the container tag module.
ContributorObj { object } { required
} { no default }
The object value of the contributor to delete.
CountIncrement { numeric } { required
} { no default }
This value will be subtracted from the variable in the container that has the
name of CountName. This value is usually a "1" or a "0", indicating whether or
not the contributor is actively contributing its value now. The contributor will
increment or decrement the value of the CountName variable as the corresponding state of
the contributor changes.
Comments: This function can be called from the contributor.