GetStreamType

(Engine-Level Function)

Description: Returns a type indication for a stream.
Returns: Numeric
Usage: Script or steady state.
Function Groups: Stream and Socket
Related to: GetStreamLength
Format: GetStreamType(Stream)
Parameters:  
Stream
Required. Any expression that returns a stream value.
Comments: This returns the type of an existing stream. Possible valid return values are as follows

Return Value

Meaning

0

file stream (temporary or persistent)

1

pipe stream

2

editor stream

3

buffer stream

4

TCP/IP socket stream

5

serial port stream

6

modem stream

7TCP control stream

Invalid is returned for all non-stream values.

Example:

  SType = GetStreamType(BuffStream("abcde"));

SType will be set to 3.