Share via


TfsMessageQueue.Dequeue Method (TimeSpan, TfsDequeueContext%)

Dequeues a message from the queue. The caller will be blocked for a maximum duration of the specified time-out.

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

Syntax

'Declaration
Public Function Dequeue ( _
    timeout As TimeSpan, _
    <OutAttribute> ByRef context As TfsDequeueContext _
) As Boolean
public bool Dequeue(
    TimeSpan timeout,
    out TfsDequeueContext context
)
public:
bool Dequeue(
    TimeSpan timeout, 
    [OutAttribute] TfsDequeueContext^% context
)
member Dequeue : 
        timeout:TimeSpan * 
        context:TfsDequeueContext byref -> bool
public function Dequeue(
    timeout : TimeSpan, 
    context : TfsDequeueContext
) : boolean

Parameters

  • timeout
    Type: System.TimeSpan

    The maximum time to wait for a message to be received

Return Value

Type: System.Boolean
True if the call returned in the specified time-out; otherwise, false

.NET Framework Security

See Also

Reference

TfsMessageQueue Class

Dequeue Overload

Microsoft.TeamFoundation.Framework.Client Namespace