OPC Studio User's Guide and Reference
MakeDescriptorString Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA Namespace > UAEndpointDescriptor Class : MakeDescriptorString Method
The URI string of the endpoint.

The value of this parameter cannot be null (Nothing in Visual Basic).

The endpoint selection policy of the endpoint.

Because the OpcLabs.EasyOpc.UA.Engine.UAEndpointSelectionPolicy has an implicit conversion from OpcLabs.EasyOpc.UA.Engine.UAMessageSecurityModes, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.Engine.UAMessageSecurityModes in place of this parameter, and the corresponding OPC UA endpoint selection policy will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.Engine.UAEndpointSelectionPolicy.UAEndpointSelectionPolicy Constructor(UAMessageSecurityModes) constructor instead.

The value of this parameter can be null (Nothing in Visual Basic).

Whether to unescape the parts of the descriptor string (for display purposes).
Creates a descriptor string from the given URI and an optional endpoint selection policy.
Syntax
'Declaration
 
<NotNullAttribute()>
Public Shared Function MakeDescriptorString( _
   ByVal uriString As String, _
   ByVal endpointSelectionPolicy As UAEndpointSelectionPolicy, _
   ByVal unescape As Boolean _
) As String
'Usage
 
Dim uriString As String
Dim endpointSelectionPolicy As UAEndpointSelectionPolicy
Dim unescape As Boolean
Dim value As String
 
value = UAEndpointDescriptor.MakeDescriptorString(uriString, endpointSelectionPolicy, unescape)
[NotNull()]
public static string MakeDescriptorString( 
   string uriString,
   UAEndpointSelectionPolicy endpointSelectionPolicy,
   bool unescape
)
[NotNull()]
public:
static String^ MakeDescriptorString( 
   String^ uriString,
   UAEndpointSelectionPolicy^ endpointSelectionPolicy,
   bool unescape
) 

Parameters

uriString
The URI string of the endpoint.

The value of this parameter cannot be null (Nothing in Visual Basic).

endpointSelectionPolicy
The endpoint selection policy of the endpoint.

Because the OpcLabs.EasyOpc.UA.Engine.UAEndpointSelectionPolicy has an implicit conversion from OpcLabs.EasyOpc.UA.Engine.UAMessageSecurityModes, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.Engine.UAMessageSecurityModes in place of this parameter, and the corresponding OPC UA endpoint selection policy will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.Engine.UAEndpointSelectionPolicy.UAEndpointSelectionPolicy Constructor(UAMessageSecurityModes) constructor instead.

The value of this parameter can be null (Nothing in Visual Basic).

unescape
Whether to unescape the parts of the descriptor string (for display purposes).

Return Value

Returns the descriptor string created from the given parts.

This method never returns null (Nothing in Visual Basic).

Remarks

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

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