This documentation is archived and is not being maintained.

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)

public:
TfsDequeueContext^ Dequeue(
	TimeSpan timeout
)

Parameters

timeout
Type: System::TimeSpan

The 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

ExceptionCondition
TimeoutException

if the specified time-out is exceeded

Show: