DeleteTags Method
- Last UpdatedAug 21, 2026
- 1 minute read
Use the DeleteTags() method to delete tags from the server.
'Declaration
Public Function DeleteTags( _
ByRef tagList As HistorianTagStatusList, _
ByRef error As HistorianAccessError _
) As Boolean'Usage
Dim instance As HistorianAccess
Dim tagList As HistorianTagStatusList
Dim error As HistorianAccessError
Dim value As Boolean
value = instance.DeleteTags(tagList, error)public bool DeleteTags(
ref HistorianTagStatusList tagList,
out HistorianAccessError error
)public:
bool DeleteTags(
HistorianTagStatusList^% tagList,
[Out] HistorianAccessError^ error
) Parameters
- tagList
- List of HistorianTagStatus objects. Each HistorianTagStatus object contains the tagname to be deleted and contains the parameters to hold error information that will be populated if the method is successful.
- error
- The object of HistorianAccessError, which contains any error information.
Return Value
Returns True if successful; otherwise, returns False.
The DeleteTags() method can only delete tags created from an SDK client. It cannot delete I/O Server tags or Wonderware Application Server tags.
Possible reasons for an error could be unknownClient, validationFailed, and a corresponding error code from HCAL. When the Historian is unavailable, the DeleteTags() method returns the communication error.