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



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugHostDescriptor Class > SparkplugHostDescriptor Constructor : SparkplugHostDescriptor Constructor(SparkplugSystemDescriptor,String)
The Sparkplug system descriptor.

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

The Sparkplug host ID.

The value represents a Sparkplug host ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus) 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 connection descriptor and host ID.
Syntax
'Declaration
 
Public Function New( _
   ByVal systemDescriptor As SparkplugSystemDescriptor, _
   ByVal hostId As String _
)
'Usage
 
Dim systemDescriptor As SparkplugSystemDescriptor
Dim hostId As String
 
Dim instance As New SparkplugHostDescriptor(systemDescriptor, hostId)
public SparkplugHostDescriptor( 
   SparkplugSystemDescriptor systemDescriptor,
   string hostId
)
public:
SparkplugHostDescriptor( 
   SparkplugSystemDescriptor^ systemDescriptor,
   String^ hostId
)

Parameters

systemDescriptor
The Sparkplug system descriptor.

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

hostId
The Sparkplug host ID.

The value represents a Sparkplug host ID. It must be a string with valid UTF-8 characters except for the reserved characters of '+' (plus) 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