Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.TimeSpanThe maximum time to wait for a message to be received
context
Type: Microsoft.TeamFoundation.Framework.Client.TfsDequeueContext%A context used for processing and acknowledging a message. If this value is null and the return value is true, the message queue has been closed.
Return Value
Type: System.Boolean
True if the call returned in the specified time-out; otherwise, false
.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.