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