Connectivity Software User's Guide and Reference
UpdateFromElements Method (UASubscribeDataSetFilter)



OpcLabs.EasyOpcUAPrimitives Assembly > OpcLabs.EasyOpc.UA.PubSub Namespace > UASubscribeDataSetFilter Class : UpdateFromElements Method
The subscribe dataset filter to update. Must not be null.

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 a UAPublisherId (containing the publisher Id that you want to allow in the filter) in place of this parameter, 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 FromUAPublisherId static method instead.

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

The URI string of the effective PubSub transport profile. Must not be null.

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

The writer group configuration element, or null if not available.

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

The dataset writer configuration element, or null if not available.

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

A list of all dataset writer elements in the group, or null if not available.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

The dataset metadata, or null if not available.

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

When true, allow errors in required field values.
Updates the subscribe dataset filter from the configuration elements, resolving physical and logical identifiers.
Syntax
'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
Public Shared Function UpdateFromElements( _
   ByVal subscribeDataSetFilter As UASubscribeDataSetFilter, _
   ByVal effectiveTransportProfileUriString As String, _
   ByVal writerGroupElement As UAWriterGroupElement, _
   ByVal dataSetWriterElement As UADataSetWriterElement, _
   ByVal groupDataSetWriterElements As IReadOnlyList(Of UADataSetWriterElement), _
   ByVal dataSetMetaData As UADataSetMetaData, _
   ByVal relaxed As Boolean _
) As Exception
'Usage
 
Dim subscribeDataSetFilter As UASubscribeDataSetFilter
Dim effectiveTransportProfileUriString As String
Dim writerGroupElement As UAWriterGroupElement
Dim dataSetWriterElement As UADataSetWriterElement
Dim groupDataSetWriterElements As IReadOnlyList(Of UADataSetWriterElement)
Dim dataSetMetaData As UADataSetMetaData
Dim relaxed As Boolean
Dim value As Exception
 
value = UASubscribeDataSetFilter.UpdateFromElements(subscribeDataSetFilter, effectiveTransportProfileUriString, writerGroupElement, dataSetWriterElement, groupDataSetWriterElements, dataSetMetaData, relaxed)

Parameters

subscribeDataSetFilter
The subscribe dataset filter to update. Must not be null.

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 a UAPublisherId (containing the publisher Id that you want to allow in the filter) in place of this parameter, 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 FromUAPublisherId static method instead.

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

effectiveTransportProfileUriString
The URI string of the effective PubSub transport profile. Must not be null.

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

writerGroupElement
The writer group configuration element, or null if not available.

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

dataSetWriterElement
The dataset writer configuration element, or null if not available.

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

groupDataSetWriterElements
A list of all dataset writer elements in the group, or null if not available.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

dataSetMetaData
The dataset metadata, or null if not available.

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

relaxed
When true, allow errors in required field values.

Return Value

Returns null on success, or an exception describing the error if relaxed is true.

This method can return null (Nothing in Visual Basic).

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