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