Connectivity Software User's Guide and Reference
SparkplugArguments Constructor(SparkplugHostDescriptor,String,String,String,String)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.OperationModel Namespace > SparkplugArguments Class > SparkplugArguments Constructor : SparkplugArguments Constructor(SparkplugHostDescriptor,String,String,String,String)
The Sparkplug host descriptor.

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

The Sparkplug group ID.

The value represents a Sparkplug group ID, or a filter for Sparkplug group IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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, or a filter for Sparkplug edge node IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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

The Sparkplug device ID.

The value represents a Sparkplug device ID, or a filter for Sparkplug device IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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

The Sparkplug metric name.

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

Initializes a new instance of the class, specifying the Sparkplug host descriptor, group ID, edge node ID, device ID, and metric name.
Syntax
'Declaration
 
Public Function New( _
   ByVal hostDescriptor As SparkplugHostDescriptor, _
   ByVal groupId As String, _
   ByVal edgeNodeId As String, _
   ByVal deviceId As String, _
   ByVal metricName As String _
)
'Usage
 
Dim hostDescriptor As SparkplugHostDescriptor
Dim groupId As String
Dim edgeNodeId As String
Dim deviceId As String
Dim metricName As String
 
Dim instance As New SparkplugArguments(hostDescriptor, groupId, edgeNodeId, deviceId, metricName)

Parameters

hostDescriptor
The Sparkplug host descriptor.

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

groupId
The Sparkplug group ID.

The value represents a Sparkplug group ID, or a filter for Sparkplug group IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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, or a filter for Sparkplug edge node IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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

deviceId
The Sparkplug device ID.

The value represents a Sparkplug device ID, or a filter for Sparkplug device IDs. It must be a string with valid UTF-8 characters except for the reserved character '/' (forward slash). Characters '+' (plus) and '#' are filters, and can only be used when they are the single character in the string.

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

metricName
The Sparkplug metric name.

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

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