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

ThisStudy.getInputParameter()

Top  Previous  Next

ThisStudy.getInputParameter( offset: Integer ) : Variant;

 

Returns a study input parameter as a Variant type. Used by a study to access and manipulate the input parameters assigned to the study. A study can have an unlimited number of input parameters but some studies will have no input parameters. The offset is zero-based, so the first parameter will be at offset 0, the second parameter will be at offset 1, the third parameter will be at offset 2, etc.

 

Parameters

 

offset

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

 

getInputParameter

 

See also:

 

ThisStudy.getInputStream()