GetStreamLength

Description:              This function returns the present length of a stream in bytes.

Returns:                    Numeric

Usage:                       Script or Steady State

Format:                      GetStreamLength(Stream)

Parameters:             Stream     { stream }  { required }  { no default }

                                              Any expression which returns a stream value.

Comments:               This function is useful in determining the size of an existing stream; it is not necessary to do a Seek prior to executing the GetStreamLength.

Example:

sLength = GetStreamLength(BuffStream("abcde"));

This function will cause sLength to be set to 5.

See Also:

BuffStream | ClientSocket | FileSize | FileStream | PipeStream | Seek | ServerSocket | StreamEnd