Connectivity Software User's Guide and Reference
Match(String,String,String) Method



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugDeviceDescriptor Class > Match Method : Match(String,String,String) Method
The Sparkplug group ID.

The value represents a Sparkplug group ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

The Sparkplug edge node ID.

The value represents a Sparkplug edge node ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

The Sparkplug device ID.

The value represents a Sparkplug device ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

Determines whether the specified Sparkplug group ID, edge node ID and device ID match the filter given by this device descriptor.
Syntax
'Declaration
 
Public Overloads Function Match( _
   ByVal groupId As String, _
   ByVal edgeNodeId As String, _
   ByVal deviceId As String _
) As Boolean
'Usage
 
Dim instance As SparkplugDeviceDescriptor
Dim groupId As String
Dim edgeNodeId As String
Dim deviceId As String
Dim value As Boolean
 
value = instance.Match(groupId, edgeNodeId, deviceId)

Parameters

groupId
The Sparkplug group ID.

The value represents a Sparkplug group ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

edgeNodeId
The Sparkplug edge node ID.

The value represents a Sparkplug edge node ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

deviceId
The Sparkplug device ID.

The value represents a Sparkplug device ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus), '/' (forward slash), and '#' (number sign).

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

Return Value

Returns true if groupId, edgeNodeId and deviceId match the filter given by this device descriptor; returns false otherwise.
Exceptions
ExceptionDescription

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.

Remarks

 

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

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