MessageReceiver.OnBeginAbandon Method

Executes upon calling the OnAbandon or BeginAbandon operation.

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

Syntax

'Declaration
Protected MustOverride Function OnBeginAbandon ( _
    trackingContext As TrackingContext, _
    lockTokens As IEnumerable(Of Guid), _
    propertiesToModify As IDictionary(Of String, Object), _
    timeout As TimeSpan, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim trackingContext As TrackingContext
Dim lockTokens As IEnumerable(Of Guid)
Dim propertiesToModify As IDictionary(Of String, Object)
Dim timeout As TimeSpan
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = Me.OnBeginAbandon(trackingContext, _
    lockTokens, propertiesToModify, _
    timeout, callback, state)
protected abstract IAsyncResult OnBeginAbandon(
    TrackingContext trackingContext,
    IEnumerable<Guid> lockTokens,
    IDictionary<string, Object> propertiesToModify,
    TimeSpan timeout,
    AsyncCallback callback,
    Object state
)
protected:
virtual IAsyncResult^ OnBeginAbandon(
    TrackingContext^ trackingContext, 
    IEnumerable<Guid>^ lockTokens, 
    IDictionary<String^, Object^>^ propertiesToModify, 
    TimeSpan timeout, 
    AsyncCallback^ callback, 
    Object^ state
) abstract
abstract OnBeginAbandon : 
        trackingContext:TrackingContext * 
        lockTokens:IEnumerable<Guid> * 
        propertiesToModify:IDictionary<string, Object> * 
        timeout:TimeSpan * 
        callback:AsyncCallback * 
        state:Object -> IAsyncResult 
protected abstract function OnBeginAbandon(
    trackingContext : TrackingContext, 
    lockTokens : IEnumerable<Guid>, 
    propertiesToModify : IDictionary<String, Object>, 
    timeout : TimeSpan, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

  • timeout
    Type: System.TimeSpan
    The time span the operation waits before it times out.
  • state
    Type: System.Object
    A user-defined object that contains state information about the asynchronous operation.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation to abandon the messages and relinquish its lock.

See Also

Reference

MessageReceiver Class

Microsoft.ServiceBus.Messaging Namespace