Connectivity Software User's Guide and Reference
FromSparkplugBrokerDescriptor Method



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugConnectionDescriptor Class : FromSparkplugBrokerDescriptor Method
The SparkplugBrokerDescriptor to use for the connection descriptor. If null, a default (null) connection descriptor is returned.

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

Creates a Sparkplug connection descriptor from a Sparkplug broker descriptor.
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function FromSparkplugBrokerDescriptor( _
   ByVal brokerDescriptor As SparkplugBrokerDescriptor _
) As SparkplugConnectionDescriptor
'Usage
 
Dim brokerDescriptor As SparkplugBrokerDescriptor
Dim value As SparkplugConnectionDescriptor
 
value = SparkplugConnectionDescriptor.FromSparkplugBrokerDescriptor(brokerDescriptor)
[JetBrains.Annotations.NotNull()]
public static SparkplugConnectionDescriptor FromSparkplugBrokerDescriptor( 
   SparkplugBrokerDescriptor brokerDescriptor
)
[JetBrains.Annotations.NotNull()]
public:
static SparkplugConnectionDescriptor^ FromSparkplugBrokerDescriptor( 
   SparkplugBrokerDescriptor^ brokerDescriptor
) 

Parameters

brokerDescriptor
The SparkplugBrokerDescriptor to use for the connection descriptor. If null, a default (null) connection descriptor is returned.

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

Return Value

A new SparkplugConnectionDescriptor initialized with the specified broker descriptor, or a default connection descriptor if brokerDescriptor is null.

This method never returns null (Nothing in Visual Basic).

Remarks

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

 

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