Navigation: Function Reference > Study Formula Functions > ThisStudy.getInputStream()

ThisStudy.getInputStream()

Top  Previous  Next

ThisStudy.getInputStream( offset: Integer ) : TEStream;

 

Returns a study input stream as a TEStream type. Used by a study to access and manipulate the input streams assigned to the study. A study can have an unlimited number of input streams but will always at least have one input stream. Always check for nil values when retrieving input streams. The offset is zero-based, so the first stream will be at offset 0, the second stream will be at offset 1, the third stream will be at offset 2, etc.

 

Parameters

 

offset

integer value (0 or positive offset into the array of available input streams)

 

getInputStream

 

See also:

 

ThisStudy.getInputParameter()