GetTagStatusByName Method (HistorianAccess)
- Last UpdatedAug 21, 2026
- 1 minute read
Use the GetTagStatusByName() method to check the current status of tag.
'Declaration
Public Sub GetTagStatusByName( _
ByRef tagStatusInformation As HistorianTagStatus _
) 'Usage
Dim instance As HistorianAccess
Dim tagStatusInformation As HistorianTagStatus
instance.GetTagStatusByName(tagStatusInformation)public void GetTagStatusByName(
ref HistorianTagStatus tagStatusInformation
)public:
void GetTagStatusByName(
HistorianTagStatus^% tagStatusInformation
) Parameters
- tagStatusInformation
- The object of the HistorianTagStatus class, which contains the status of the tag.
Return Value
Returns the Historian error code.
If the AddTag() method is successful, the tag is created in the internal HCAL cache and gets asynchronously synchronized with the server as a background task. If you have provided a store-and-forward path, you can start storing data for that tag immediately. The HCAL will automatically switch to the server when it becomes available. If the store-and-forward path was not specified, the managed HCAL application must wait until all tags have been successfully created on the server before it can send any data values. You can check the creation status for a tag using the GetTagStatusByName() method.