EventDataBatch.TryAdd(EventData) Method

Reference

Definition

Namespace:: Microsoft.Azure.EventHubs

Assembly:: Microsoft.Azure.EventHubs.dll

Package:: Microsoft.Azure.EventHubs v4.3.2

Source:: EventDataBatch.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Tries to add an event data to the batch if permitted by the batch's size limit.

public bool TryAdd (Microsoft.Azure.EventHubs.EventData eventData);

member this.TryAdd : Microsoft.Azure.EventHubs.EventData -> bool

Public Function TryAdd (eventData As EventData) As Boolean

Parameters

eventData: EventData

The EventData to add.

Returns

Boolean

A boolean value indicating if the event data has been added to the batch or not.

Exceptions

ArgumentNullException

Thrown when the EventData is null.

ObjectDisposedException

Thrown when the batch is already disposed.

Remarks

This method checks the sizes of the batch, the EventData object and the specified limit to determine if the EventData object can be added.

Applies to