OnBeginAbandon Method
Begins an asynchronous operation to abandon the message and relinquish its lock.
Namespace: Microsoft.ServiceBus.Messaging
Assembly: Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)
Syntax
'Declaration
Protected Overrides Function OnBeginAbandon ( _
trackingContext As TrackingContext, _
lockTokens As IEnumerable(Of Guid), _
timeout As TimeSpan, _
callback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim trackingContext As TrackingContext
Dim lockTokens As IEnumerable(Of Guid)
Dim timeout As TimeSpan
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = Me.OnBeginAbandon(trackingContext, _
lockTokens, timeout, callback, state)
protected override IAsyncResult OnBeginAbandon(
TrackingContext trackingContext,
IEnumerable<Guid> lockTokens,
TimeSpan timeout,
AsyncCallback callback,
Object state
)
protected:
virtual IAsyncResult^ OnBeginAbandon(
TrackingContext^ trackingContext,
IEnumerable<Guid>^ lockTokens,
TimeSpan timeout,
AsyncCallback^ callback,
Object^ state
) override
abstract OnBeginAbandon :
trackingContext:TrackingContext *
lockTokens:IEnumerable<Guid> *
timeout:TimeSpan *
callback:AsyncCallback *
state:Object -> IAsyncResult
override OnBeginAbandon :
trackingContext:TrackingContext *
lockTokens:IEnumerable<Guid> *
timeout:TimeSpan *
callback:AsyncCallback *
state:Object -> IAsyncResult
protected override function OnBeginAbandon(
trackingContext : TrackingContext,
lockTokens : IEnumerable<Guid>,
timeout : TimeSpan,
callback : AsyncCallback,
state : Object
) : IAsyncResult
Parameters
- trackingContext
Type: Microsoft.ServiceBus.Tracing. . :: . .TrackingContext
The context information associated by a transaction tracking this operation.
- lockTokens
Type: System.Collections.Generic. . :: . .IEnumerable< (Of < ( <'Guid> ) > ) >
The lock tokens of the BrokeredMessage collection. This is only available when a message is received in peek-lock mode. The lock token is used internally to complete or abandon a message.
- timeout
Type: System. . :: . .TimeSpan
The time span interval the operation waits before it times out.
- callback
Type: System. . :: . .AsyncCallback
An AsyncCallback delegate that references the method to invoke when the operation is complete.
- 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.
Remarks
This is a protected member of the abstract MessageSession class. Abstract classes are not meant to be inherited, so protected members should be ignored. The public methods for OnBeginAbandon are Abandon and BeginAbandon.