GetTagConfiguredParameters

(VTScada-Layer function. Must be called with a leading backslash.)

Description: Fetches a dictionary of tag parameters.
If the Deployed parameter is TRUE, fetches the tag parameters in the database for the latest deployed revision. The latest deployed revision may not match the parameters on your workstation if your workstation has local changes to the tag.
Returns: Dictionary
Usage: Script Only.
Function Groups: Module - Advanced
Related to: |ModifyTags |OpChange | | | | |
Format: Code.GetTagConfiguredParameters("TagName", &pParmsDict[, Deployed]);
Parameters:  
TagName
Required text. The name of the tag to retrieve changed/overridden parameters
pParmsDict
Required. Pointer to a value that will be set to the dictionary of configured tag parameters.
Deployed
Optional Boolean. TRUE to fetch deployed version of the given tag's parameters. Defaults to FALSE to get the current set of tag parameters on this workstation, regardless of whether or not they have been deployed.
Comments:

If the Deployed parameter is FALSE, fetches the tag parameters in the base cache for the latest application version.
If the given tag is declared in the database, fetches all parameters that have been explicitly set for that tag.
If the tag is declared in a type database, fetches all the overrides that are defined in the database for that tag. (returning an empty dictionary if there are none.)
If the given tag does not exist, the return is Invalid.

To be used with OpChange and ModifyTags when they are called with the Merge==FALSE parameter. This API makes it possible to revert a tag parameter to its default or remove an override and modify some configured parameters while keeping others.

Example:

[
Code.GetTagConfiguredParameters("MyTagName", &pParmsDict, TRUE);
]