FetchTaggedValue Method
The FetchTaggedValue method returns the TaggedValue associated with the supplied tag name or row number in the TaggedValues array of the attribute.
This method has the following syntax:
TaggedValue = AttributeObject.FetchTaggedValue(tag = varchar(256) |
row = integer, item =Object)
This method has the following parameters:
tag
(Either this parameter or row is required.) (Required) Specifies the name of the tag to be stored or accessed in the TaggedValues array.
If an Item parameter is supplied, the tag name must be suffixed by a subtag, delimited from the main tag name by the "#" character. This subtag is used to uniquely identify and access the object item being stored. If the specified subtag has already been used, the supplied item will replace whatever object was previously stored using that subtag; if the supplied item is a null, the subtag entry will be deleted.
For example, if a tagged value with tag name "test" has two objects (items) stored, the first with subtag "one", the second with subtag "two", the following code retrieves the second object:
myAppSource.FetchTaggedValue(tag='test#two', item=Byref(myseconditem));
Note: The "&" character is reserved. Use of either "#" and "&" within tag or subtag names leads to unpredictable results.
For more information about how multiple items may be stored for a tagged value, see the
SetTaggedValue Method.
row
Specifies the row number in the TaggedValues array
item
Specifies an object to be stored as one of the KeyedItems in the tagged value being created or changed.
This method returns the TaggedValue, or NULL if the entry for this tag or index is not present.