TeamFoundationMessageQueueService.BeginDequeue Method (TeamFoundationRequestContext, String, Guid, Int64, IList<AcknowledgementRange>, MessageHeaders, TimeSpan, AsyncCallback, Object)

Begins an asynchronous dequeue operation on a message queue.

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
Public Function BeginDequeue ( _
    requestContext As TeamFoundationRequestContext, _
    queueName As String, _
    sessionId As Guid, _
    lastMessageId As Long, _
    ranges As IList(Of AcknowledgementRange), _
    headers As MessageHeaders, _
    timeout As TimeSpan, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

public IAsyncResult BeginDequeue(
    TeamFoundationRequestContext requestContext,
    string queueName,
    Guid sessionId,
    long lastMessageId,
    IList<AcknowledgementRange> ranges,
    MessageHeaders headers,
    TimeSpan timeout,
    AsyncCallback callback,
    Object state
)

public:
IAsyncResult^ BeginDequeue(
    TeamFoundationRequestContext^ requestContext, 
    String^ queueName, 
    Guid sessionId, 
    long long lastMessageId, 
    IList<AcknowledgementRange^>^ ranges, 
    MessageHeaders^ headers, 
    TimeSpan timeout, 
    AsyncCallback^ callback, 
    Object^ state
)

member BeginDequeue : 
        requestContext:TeamFoundationRequestContext * 
        queueName:string * 
        sessionId:Guid * 
        lastMessageId:int64 * 
        ranges:IList<AcknowledgementRange> * 
        headers:MessageHeaders * 
        timeout:TimeSpan * 
        callback:AsyncCallback * 
        state:Object -> IAsyncResult

public function BeginDequeue(
    requestContext : TeamFoundationRequestContext, 
    queueName : String, 
    sessionId : Guid, 
    lastMessageId : long, 
    ranges : IList<AcknowledgementRange>, 
    headers : MessageHeaders, 
    timeout : TimeSpan, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

  The request context

• queueName
  Type: System.String

  The queue identifier

• sessionId
  Type: System.Guid

  The session identifier

• lastMessageId
  Type: System.Int64

  The last message identifier, if available

• ranges
  Type: System.Collections.Generic.IList<AcknowledgementRange>

  An optional array of message ranges which should be acknowledged

• headers
  Type: System.ServiceModel.Channels.MessageHeaders

  Additional headers which should apply to this dequeue operation, if any

• timeout
  Type: System.TimeSpan

  The System.TimeSpan that specifies the interval of time to wait for an item to become available.

• callback
  Type: System.AsyncCallback

  The System.AsyncCallback delegate that receives notification that the operation is complete.

• state
  Type: System.Object

  An object, specified by the caller, that contains state information associated with the asynchronous operation.

Return Value

Type: System.IAsyncResult
An asynchronous operation to dequeue a message from a queue

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

TeamFoundationMessageQueueService Class

BeginDequeue Overload

Microsoft.TeamFoundation.Framework.Server Namespace