Connectivity Software User's Guide and Reference
HandleAndReturn Method (SparkplugProducerPollEventArgs)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.OperationModel Namespace > SparkplugProducerPollEventArgs Class : HandleAndReturn Method
The Sparkplug payload.

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

Indicate that the event has been completely handled, and return the specified Sparkplug payload as the event handling result.
Syntax
'Declaration
 
Public Sub HandleAndReturn( _
   ByVal payload As SparkplugPayload _
) 
'Usage
 
Dim instance As SparkplugProducerPollEventArgs
Dim payload As SparkplugPayload
 
instance.HandleAndReturn(payload)
public void HandleAndReturn( 
   SparkplugPayload payload
)
public:
void HandleAndReturn( 
   SparkplugPayload^ payload
) 

Parameters

payload
The Sparkplug payload.

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

Remarks

Marks the event as handled and sets the specified Sparkplug payload as the result of the event handling.

Calling this method indicates that the event has been fully processed and no further action is required. The specified payload will be used as the outcome of the event handling, containing the payload with payload elements that result from the poll operation.

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