StreamEnum

The StreamEnum function is supported in both Studio and Search. It returns the number of rows matching the Where Clause. The function will look for the first occurrence of an attribute whose data type is table and will select table rows using the Where Clause returning the number of selected rows.

StreamEnum replaces the obsolete StreamCount function.

Prototype

    StreamEnum(PreviousCase; Direction; ObjectStatusValue; ObjectStatusAttribute )

Arguments

    PreviousCase              String     By value (Nullable)  

    Null (not defined) or empty string or equal to:

       'N' -- work on current case
       'Y' -- work on previous case

    Direction                 String     By value (Nullable)

    A valid String containing:

       I - count input streams
       O - count output streams
       A - count attached streams

    Null (not defined) or Empty string - count all connected streams

    ObjectStatusValue         String     By value (Nullable) 

    A Null (Not defined) or empty string if the function has not filtered out elements based on their object status. 
    Otherwise, a valid string containing the object status value.

    ObjectStatusAttribute     String     By value (Nullable)  

    A Null (Not defined) or empty string if the function has not filtered out elements based on their object status. 
    Otherwise, a valid string containing the attribute name.

Returns

    Number

    The functions returns the number of connected streams according to the selected Direction. Zero, if no streams are connected.

Exception

    Undefined

    Undefined is returned if:

    - PreviousCase is not empty and not a valid one, or the previous case does not exist
    - Invalid Direction

Example 

    StreamEnum( ; ; 'IS' ; 'ObjectStatus' )

This will return 0, if no streams are connected. Otherwise, the number of connected streams whose ObiectStatus attribute value is equal to IS.