FromInternalValue(Object) Method

Converts an internal value into a publisher Id.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CLSCompliantAttribute(False)>
<JetBrains.Annotations.MustUseReturnValueAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
<JetBrains.Annotations.PureAttribute()>
Public Overloads Shared Function FromInternalValue( _
   ByVal internalValue As Object _
) As UAPublisherId

'Usage
 
Dim internalValue As Object
Dim value As UAPublisherId
 
value = UAPublisherId.FromInternalValue(internalValue)

[CLSCompliant(false)]
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
[JetBrains.Annotations.Pure()]
public static UAPublisherId FromInternalValue( 
   object internalValue
)

[CLSCompliant(false)]
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
[JetBrains.Annotations.Pure()]
public:
static UAPublisherId^ FromInternalValue( 
   Object^ internalValue
)

Parameters

internalValue: Internal value of the publisher Id identifier.
The value of this parameter can be null (Nothing in Visual Basic).

Return Value

Returns a publisher Id with the specified internal 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).

This return value of this method should not be ignored.

Remarks

Internal value is used in the OPC-UA PubSub specification, not CLS-compliant. It is System.Byte, System.UInt16, System.UInt32, System.UInt64, System.String, or null.

This method uses strict validation (equivalent to calling the overload with relaxed parameter set to false). Zero numeric values and empty strings are considered invalid and will cause the validation to fail.

This method is pure, i.e. it does not have observable side effects.

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
Overload List
FromInternalValue(Object,Boolean) Method

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.