ConnectionTest tests the connection to an asset on the network.
Signature
ConnectionTest(
[in] 0:String AssetEndpoint
[out] 0:Boolean Success
[out] 0:String Status);
Table 11 – ConnectionTest Method Arguments
|
Argument |
Description |
|
AssetEndpoint |
The endpoint description of the asset to test the connection to. |
|
Success |
Returns TRUE if a connection could be established to the asset, FALSE otherwise. |
|
Status |
If a connection was established successfully, an asset-specific status code string describing the current health of the asset is returned. |
Method Result Codes
|
Result Code Symbolic Id |
Description |
|
Bad_UserAccessDenied |
The session (including the user) does not have the permissions required. |
|
Good |
A connection was established successfully. |