CloseStorageConnection(HistorianAccessError) Method
- Last UpdatedAug 21, 2026
- 1 minute read
Use the CloseStorageConnection() method to flush all memory buffers that contain store-and-forward snapshots to storage so that HCAL can start forwarding the snapshots to the Historian. After this call, all storage-related functions, such as the AddTag() method or AddStreamValues() method, will not be allowed and will return an error. Retrieval functions, including status checkings, are still valid.
'Declaration
Public Function CloseStorageConnection( _
ByRef error As HistorianAccessError _
) As Boolean
'Usage
Dim instance As HistorianAccess
Dim error As HistorianAccessError
Dim value As Boolean
value = instance.CloseStorageConnection(error)
public bool CloseStorageConnection(
out HistorianAccessError error
)
public:
bool CloseStorageConnection(
[Out] HistorianAccessError^ error
)
Parameters
- error
Return Value
Returns the Historian error code.