OPC Studio User's Guide and Reference
TestEndpoint Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Extensions Namespace > IEasyUAClientExtension2 Class : TestEndpoint Method
The client object that will perform the operation.
The endpoint descriptor.
Tests whether an operational connection can be established to the specified endpoint of an OPC UA server.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Function TestEndpoint( _
   ByVal client As IEasyUAClient, _
   ByVal endpointDescriptor As UAEndpointDescriptor _
) As Byte
'Usage
 
Dim client As IEasyUAClient
Dim endpointDescriptor As UAEndpointDescriptor
Dim value As Byte
 
value = IEasyUAClientExtension2.TestEndpoint(client, endpointDescriptor)

Parameters

client
The client object that will perform the operation.
endpointDescriptor
The endpoint descriptor.

Return Value

Returns the service level of the server, if the test succeeds; otherwise, throws a OpcLabs.EasyOpc.UA.OperationModel.UAException.
Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

The service level describes the ability of the server to provide its data to the client, and is determined by reading the OpcLabs.EasyOpc.UA.AddressSpace.Standard.UAVariableIds.Server_ServiceLevel node.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also