AddTagExtendedProperties Method
- Last UpdatedAug 21, 2026
- 1 minute read
Use the AddTagExtendedProperties() method to add tag extended properties to the server or local cache.
'Declaration
Public Function AddTagExtendedProperties( _
ByVal tagExtendedPropertyGroupList As TagExtendedPropertyGroupList, _
ByRef error As HistorianAccessError _
) As Boolean'Usage
Dim instance As HistorianAccess
Dim tagExtendedPropertyGroupList As TagExtendedPropertyGroupList
Dim error As HistorianAccessError
Dim value As Boolean
value = instance.AddTagExtendedProperties(tagExtendedPropertyGroupList, error)public bool AddTagExtendedProperties(
TagExtendedPropertyGroupList tagExtendedPropertyGroupList,
out HistorianAccessError error
)public:
bool AddTagExtendedProperties(
TagExtendedPropertyGroupList^ tagExtendedPropertyGroupList,
[Out] HistorianAccessError^ error
) Parameters
- tagExtendedPropertyGroupList
- This is the object of TagExtendedPropertyGroupList. It contains tag extended properties to be stored on the server.
- error
- The object of HistorianAccessError. Stored with the error information, if any.
Return Value
Returns true if no error.
The AddTagExtendedProperties() method adds tag extended properties to the server or local cache. When the server is available, the tag extended properties is stored in the server. If the server is not available, the tag extended properties is cached locally and synchronized once the server is available.
The AddTagExtendedProperties() returns error information if any error occurs. Possible reasons for an error could be unknownClient, validationFailed, and a corresponding error code from the HCAL.
Make sure to call this method only after establishing a connection.