TfsMessageQueue.Dequeue Method (TimeSpan)
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 _
) As TfsDequeueContext
public TfsDequeueContext Dequeue(
TimeSpan timeout
)
public:
TfsDequeueContext^ Dequeue(
TimeSpan timeout
)
member Dequeue :
timeout:TimeSpan -> TfsDequeueContext
public function Dequeue(
timeout : TimeSpan
) : TfsDequeueContext
Parameters
timeout
Type: System.TimeSpanThe maximum time to wait for a message to be received
Return Value
Type: Microsoft.TeamFoundation.Framework.Client.TfsDequeueContext
The message which was dequeued from the server, or null if the queue has been closed
Exceptions
| Exception | Condition |
|---|---|
| TimeoutException | if the specified time-out is exceeded |
.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.