DeleteTagExtendedPropertiesByName Method
- Last UpdatedAug 21, 2026
- 1 minute read
Use the DeleteTagExtendedPropertyGroup() method to delete the extended properties of a tag.
'Declaration
Public Function DeleteTagExtendedPropertiesByName( _
ByVal tagName As String, _
ByVal propertyNames As StringCollection, _
ByVal deleteFromServer As Boolean, _
ByRef error As HistorianAccessError _
) As Boolean
'Usage
Dim instance As HistorianAccess
Dim tagName As String
Dim propertyNames As StringCollection
Dim deleteFromServer As Boolean
Dim error As HistorianAccessError
Dim value As Boolean
value = instance.DeleteTagExtendedPropertiesByName(tagName, propertyNames, deleteFromServer, error)
public bool DeleteTagExtendedPropertiesByName(
string tagName,
StringCollection propertyNames,
bool deleteFromServer,
out HistorianAccessError error
)
public:
bool DeleteTagExtendedPropertiesByName(
String^ tagName,
StringCollection^ propertyNames,
bool deleteFromServer,
[Out] HistorianAccessError^ error
)
Parameters
- tagName
- Name of the tag for which extended properties to be deleted.
- propertyNames
- Collection of property names to be deleted for a tag.
- deleteFromServer
- if true deletes from server, Store Forward(SF) and cache. If false deletes from SF and cache only. Default would be false.
- error
- Sets error in the HistorianAccessError object in case of failure, otherwise it will be null.