CreateUInt16 Method

Creates a publisher Id with given UInt16 identifier.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
<PureAttribute()>
Public Shared Function CreateUInt16( _
   ByVal uint16Identifier As Integer _
) As UAPublisherId

'Usage
 
Dim uint16Identifier As Integer
Dim value As UAPublisherId
 
value = UAPublisherId.CreateUInt16(uint16Identifier)

[NotNull()]
[Pure()]
public static UAPublisherId CreateUInt16( 
   int uint16Identifier
)

[NotNull()]
[Pure()]
public:
static UAPublisherId^ CreateUInt16( 
   int uint16Identifier
)

Parameters

uint16Identifier: A UInt16 identifier of the publisher Id.
Valid values of this parameter are in the range from 1 to 65535.

Return Value

Returns a UInt16 publisher Id with the specified identifier.

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).

Remarks

Intentionally, CLS-compliant wider input type is used.

It is intentional that there is no way to directly construct a numerical UAPublisherId without having to somehow explicitly state the desired type. This design attempts to prevent unwanted creation of publisher Ids with wrong type.

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

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.