GetTagExtendedPropertiesByName Method
- Last UpdatedAug 21, 2026
- 1 minute read
The GetTagExtendedPropertiesByName() method gets all the tag properties and its extended properties from the cache or Historian Server using tagname as a parameter.
'Declaration
Public Function GetTagExtendedPropertiesByName( _
ByVal tagname As String, _
ByVal loadFromServer As Boolean, _
ByRef tagExtendedPropertyGroup As TagExtendedPropertyGroup, _
ByRef error As HistorianAccessError _
) As Boolean'Usage
Dim instance As HistorianAccess
Dim tagname As String
Dim loadFromServer As Boolean
Dim tagExtendedPropertyGroup As TagExtendedPropertyGroup
Dim error As HistorianAccessError
Dim value As Boolean
value = instance.GetTagExtendedPropertiesByName(tagname, loadFromServer, tagExtendedPropertyGroup, error)public bool GetTagExtendedPropertiesByName(
string tagname,
bool loadFromServer,
out TagExtendedPropertyGroup tagExtendedPropertyGroup,
out HistorianAccessError error
)public:
bool GetTagExtendedPropertiesByName(
String^ tagname,
bool loadFromServer,
[Out] TagExtendedPropertyGroup^ tagExtendedPropertyGroup,
[Out] HistorianAccessError^ error
) Parameters
- tagname
- The tagname for which the tag extended properties information will be retrieved.
- loadFromServer
- If set to true, the tag extended properties is loaded from the server. If set to false, the tag extended properties is loaded from the local cache.
- tagExtendedPropertyGroup
- The object of TagExtendedPropertyGroup, which contains tag extended properties.
- error
- The object of HistorianAccessError, which contains any error information.
Return Value
Returns True if successful; otherwise, returns False.