Parse Method (UAPublisherId)

Parses a string containing an OPC-UA publisher Id, and returns a corresponding publisher Id object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Public Shared Function Parse( _
   ByVal value As String, _
   ByVal ignoreCase As Boolean _
) As UAPublisherId

'Usage
 
Dim value As String
Dim ignoreCase As Boolean
Dim value As UAPublisherId
 
value = UAPublisherId.Parse(value, ignoreCase)

[NotNull()]
public static UAPublisherId Parse( 
   string value,
   bool ignoreCase
)

[NotNull()]
public:
static UAPublisherId^ Parse( 
   String^ value,
   bool ignoreCase
)

Parameters

value: A string representation of the publisher Id.
The value of this parameter cannot be null (Nothing in Visual Basic).
ignoreCase: true to ignore case in the type part; false to regard case in the type part.

Return Value

Returns the OPC-UA publisher Id object parsed from the input value.

Because the UASubscribeDataSetFilter has an implicit conversion from UAPublisherId, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned UAPublisherId (containing the publisher Id that you want to allow in the filter) in any place where UASubscribeDataSetFilter is expected as input, and the corresponding OPC UA subscribe dataset filter will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UASubscribeDataSetFilter.FromUAPublisherId static method instead.

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

Exceptions

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. 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.
System.ArgumentNullException	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.
System.FormatException	The format of an argument is invalid, or a composite format string is not well-formed.
System.OverflowException	An arithmetic, casting, or conversion operation in a checked context resulted in an overflow.

Remarks

The string representation is either an empty string, or "[Byte/UInt16/UInt32/UInt64/String]value".

Requirements

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

Reference

UAPublisherId Class
UAPublisherId Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.