GetSeriesSize

Get the current size of the series. Used with Non Auto Indexed Series to find the size when assigning values. If the series is too small, increase with SetSeriesSize.

Syntax:

seriesSize = GetSeriesSize( seriesName )

 

Parameter:

Description:

seriesName

Name of manually sized IPV & BPV series arrays.  Manually means the Auto-Index option is disabled.

returns

Assign the number of elements in the named series.

 

Example:

VARIABLES: seriesSize   TYPE: integer
 
'  Set instrument.myCustomSeries size to 34
SetSeriesSize(instrument.myCustomSeries, 34)

 
' Get the current size.
seriesSize = GetSeriesSize( instrument.myCustomSeries )
 
' If we have enough space, then set the value.
IF index < seriesSize THEN
  instrument.myCustomSeries[ index ] = someNumber
ELSE
  ERROR "The index is too large for the series myCustomSeries"
ENDIF
 
Print "seriesSize = ", seriesSize

Returns:

seriesSize = , 34

 

Links:

SetSeriesSize, SetSeriesValues

See Also:

Series Functions

 


Edit Time: 5/10/2017 10:29:10 AM


Topic ID#: 357

 

Created with Help & Manual 7 and styled with Premium Pack Version 2.80 © by EC Software