TestConnection Method
- Last UpdatedAug 21, 2026
- 1 minute read
Use the TestConnection() method to test if connection can be made to the Historian Server.
'Declaration
Public Function TestConnection( _
ByVal historianConnectionInfo As HistorianConnectionArgs, _
ByRef error As HistorianAccessError _
) As Boolean'Usage
Dim instance As HistorianAccess
Dim historianConnectionInfo As HistorianConnectionArgs
Dim error As HistorianAccessError
Dim value As Boolean
value = instance.TestConnection(historianConnectionInfo, error)public bool TestConnection(
HistorianConnectionArgs historianConnectionInfo,
out HistorianAccessError error
)public:
bool TestConnection(
HistorianConnectionArgs^ historianConnectionInfo,
[Out] HistorianAccessError^ error
) Parameters
- historianConnectionInfo
- An object of HistorianConnectionArgs, which contains server connection details such as the server name and the logon credentials for the computer hosting the server.
- error
- The object of HistorianAccessError, which contains any error information.
Return Value
Returns True if successful; otherwise, returns False.