SubscriptionGetInfo
Reads the specified text information about a subscribed tag.
Syntax
SubscriptionGetInfo(iHandle, sAttribute )
iHandle
Integer handle of the subscription to read from.
sAttribute
Attribute of the tag to read. Supported Attributes are:
- ClusterName - Return the cluster context of the subscription. For example, for the tag subscribed as "cluster1.tagname", return value is "cluster1". If the tag was subscribed without a cluster the return value will be an empty string.
- FullName - Return the full subscription name. For example, for the tag subscribed as "cluster1.tagname.field", return value is "cluster1.tagname.field". If the tag was subscribed without a cluster, the return value will be the tag name and/or element name.
If the tag was subscribed without an element, the return value will be the
tag name and/or cluster name.
- TagName - Return the tagname for the subscription. For example, for the tag subscribed as "cluster1.tagname", return value is "tagname".
- ElementName - Retrieve the element name of the subscription.
Return Value
String representation of the requested information for a subscribed tag. On error, returns an empty string and an error is set.
Related Functions
SubscriptionGetTimestamp, SubscriptionGetQuality, SubscriptionGetValue, SubscriptionGetTag
Example
STRING TagName = SubscriptionGetInfo(hSub, "TagName");
See Also
Tag Functions
Published June 2018