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..::Subscribe Method (StreamProperties, String, String)

Subscribes to a stream with a predicate to apply to output tuples. The stream name of dequeued tuples is sLogicalStream. When unsubscribing, use sLogicalStream.

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 StreamProperties Subscribe(
    	StreamProperties props,
    	string sLogicalStream,
    	string sPredicate
    )

    Public Function Subscribe ( _
    	props As StreamProperties, _
    	sLogicalStream As String, _
    	sPredicate As String _
    ) As StreamProperties

    public:
    StreamProperties^ Subscribe(
    	StreamProperties^ props,
    	String^ sLogicalStream,
    	String^ sPredicate
    )

#### Parameters

props
  StreamProperties
  the stream to which to subscribe

sLogicalStream
  String
  the name of the logical stream to associate with this predicate (if empty or null, defaults to streamname)

sPredicate
  String
  a predicate to apply to subset the stream

#### Return Value

the StreamProperties for the stream

# Exceptions

Exception | Condition
--- | ---
StreamBase.SB..::..StreamBaseException | thrown on error, including empty or null predicate

# See Also

StreamBaseClient Class
Subscribe Overload
StreamBase.SB.Client Namespace