PublishPayload Method (EasySparkplugHostApplication)

Publishes the specified payload to the Sparkplug system.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function PublishPayload( _
   ByVal payloadPublicationArguments As SparkplugPayloadPublicationArguments _
) As Exception

'Usage
 
Dim instance As EasySparkplugHostApplication
Dim payloadPublicationArguments As SparkplugPayloadPublicationArguments
Dim value As Exception
 
value = instance.PublishPayload(payloadPublicationArguments)

public Exception PublishPayload( 
   SparkplugPayloadPublicationArguments payloadPublicationArguments
)

public:
Exception^ PublishPayload( 
   SparkplugPayloadPublicationArguments^ payloadPublicationArguments
)

Parameters

payloadPublicationArguments: The Sparkplug payload publication arguments.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

If the publishing has succeeded, this method returns null. If the publishing has failed, this method returns an exception object describing the failure.

This method can return null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	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.

System.ArgumentNullException

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

Reference

EasySparkplugHostApplication Class
EasySparkplugHostApplication Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.