Connectivity Software User's Guide and Reference
SparkplugDevice Constructor(String)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugDevice Class > SparkplugDevice Constructor : SparkplugDevice Constructor(String)
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).

Initializes a new instance of the class with the specified Sparkplug device ID.
Syntax
'Declaration
 
Public Function New( _
   ByVal deviceId As String _
)
'Usage
 
Dim deviceId As String
 
Dim instance As New SparkplugDevice(deviceId)
public SparkplugDevice( 
   string deviceId
)
public:
SparkplugDevice( 
   String^ deviceId
)

Parameters

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

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