Skip to content

Reference

EndpointDescriptionExtensions Members

Provides extension methods to get and set the address and the security policy of an EndpointDescription.

Reference

EndpointDescriptionExtensions Members ​

Type
EndpointDescriptionExtensions
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0

Methods ​

GetAddress ​

static

Gets the URL of the endpoint specified.

csharp
public static Uri GetAddress(this EndpointDescription endpoint)
vbnet
Public Shared Function GetAddress(endpoint As EndpointDescription) As Uri

Parameters

NameTypeDescription
endpointEndpointDescriptionThe endpoint whose URL is to be returned.

Returns

Uri

The URL of the endpoint, or a null reference (Nothing in Visual Basic) if its URL is not an absolute URI.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe endpoint is a null reference (Nothing in Visual Basic).

GetEndpointPolicy ​

static

Gets the security policy of the endpoint specified.

csharp
public static OpcSecurityPolicy GetEndpointPolicy(
    this EndpointDescription endpoint)
vbnet
Public Shared Function GetEndpointPolicy(
    endpoint As EndpointDescription) As OpcSecurityPolicy

Parameters

NameTypeDescription
endpointEndpointDescriptionThe endpoint whose security policy is to be returned.

Returns

OpcSecurityPolicy

A new OpcSecurityPolicy using the security mode and the security algorithm of the endpoint.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe endpoint is a null reference (Nothing in Visual Basic).

Remarks

A security policy URI of the endpoint which is not one of the algorithms of OpcSecurityAlgorithm results in the algorithm None.

SetAddress ​

static

Sets the URL of the endpoint to the address specified.

csharp
public static void SetAddress(this EndpointDescription endpoint, Uri address)
vbnet
Public Shared Sub SetAddress(endpoint As EndpointDescription, address As Uri)

Parameters

NameTypeDescription
endpointEndpointDescriptionThe endpoint whose URL is to be set.
addressUriThe new URL of the endpoint, or a null reference (Nothing in Visual Basic) to remove the URL.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe endpoint is a null reference (Nothing in Visual Basic).

SetEndpointPolicy ​

static

Sets the security mode and the security policy URI of the endpoint to those of the endpointPolicy specified.

csharp
public static void SetEndpointPolicy(
    this EndpointDescription endpoint,
    OpcSecurityPolicy endpointPolicy)
vbnet
Public Shared Sub SetEndpointPolicy(
    endpoint As EndpointDescription,
    endpointPolicy As OpcSecurityPolicy)

Parameters

NameTypeDescription
endpointEndpointDescriptionThe endpoint whose security policy is to be set.
endpointPolicyOpcSecurityPolicyThe security policy to use.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe endpoint or the endpointPolicy is a null reference (Nothing in Visual Basic).