GetStreamText

Get a pointer to the current string.

Synopsis

char *GetStreamText (TextContextPtr ctx, int32 channelNumber)

Description

Returns a pointer to the character string on the specified channel at the current current channel and stream time. This pointer is guaranteed to be valid only until the next call to GetStreamText or GetStreamTextCel.

Arguments

cxt: Pointer to Text subscriber context.

channelNumber: Logical stream channel number.

Return Value

Returns a character pointer, or NULL in the event of an error or if there is no string on the given channel at the current stream time.

Caveat

This function is part of the Subscriber.lib library file that can currently (Toolkit1.5) be found in Attic:Streaming:2p1:DataStream:Subscribers:Subscriber.lib. It will later be integrated into the main Streaming tree.

Associated Files

TextSubscriber.h