Collapse All Expand All | Language Filter: C#Language Filter: Visual Basic Language Filter: Visual C++ C# Visual Basic Visual C++ | See Also
StreamBase Client API
StreamBaseClient..::Dequeue Method

Dequeue tuples from any subscribed stream. This method blocks until

- at least one tuple is available on any subscribed stream (DequeueResult.Status==GOOD), or
- the node is shut down (DequeueResult.Status==CLOSED), or
- a network error occurs(StreamBaseException is thrown)

If the node is shut down and no Tuples have been dequeued, the returned DequeueResult object will contain 0 Tuples and its Status property will be DequeueResult.CLOSED.

Note:
The DequeueResult will only contain valid data until Dequeue() is called again.

Namespace: StreamBase.SB.Client
Assembly: StreamBase.SB.Client (in StreamBase.SB.Client.dll) Version: 10.3.0.0

# Syntax

| C# |  |  | Visual Basic |  |  | Visual C++ |

    public DequeueResult Dequeue()

    Public Function Dequeue As DequeueResult

    public:
    DequeueResult^ Dequeue()

#### Return Value

a DequeueResult containing the results of the operation

# Exceptions

Exception | Condition
--- | ---
StreamBase.SB..::..StreamBaseException | General problem occurred

# See Also

StreamBaseClient Class
Dequeue Overload
StreamBase.SB.Client Namespace
StreamBase.SB.Client.DequeueResult