This documentation is archived and is not being maintained.

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)

public:
bool Dequeue(
	TimeSpan timeout, 
	[OutAttribute] TfsDequeueContext^% context
)

Parameters

timeout
Type: System::TimeSpan

The 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

Show: