(VTScada-Layer function. Must be called with a leading backslash.)
| Description: | Removes a contributor from a container. |
| Returns: | Numeric |
Usage:  |
Script Only. |
| Function Groups: | Containers and Contributor |
| Related to: | AddContributor |GetContributors |PContributor |
| Format: |
\DeleteContributor(HandleName, ArrayName, CountName, ContainerObj, ContributorObj, CountIncrement); |
| Parameters: |
| HandleName |
| Required. The name of the handle variable in the container module. |
| ArrayName |
| Required. 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 |
| Required. 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 |
| Required. The object value of the container tag module. |
| ContributorObj |
| Required. The object value of the contributor to delete. |
| CountIncrement |
| Required. 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 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: |
Used only when writing custom tags with code (as opposed to creating them from Context tags). See: Containers, Contributors and Site Tags This function can be called from the contributor. |
Example:
Refer to the tag template .SRC file, provided in the Examples folder of your VTScada installation.
