getMonth()

ICE Data Services -

getMonth() Series Functions


The getMonth() function is used to create a Series Object of the month values or to retrieve individual month values.

 
Syntax

getMonth( [ nBarIndex ][, sym() | inv() ] )


Parameters
 
Parameter: Description: Default:
nBarIndex [Optional]   Number of bar index of series to retrieve n/a
sym() or  inv() [Optional]  Function of sym() or inv() to determine source for month values. n/a


Return Value(s)

Returns a Series Object when nBarIndex is not specified.

Returns a single value when nBarIndex is specified.

 

Notes

N/A

 

Code Examples

function main() {

//retrieve the value for the current price bar
myVar =
getMonth(0);
//retrieve the value for the previous price bar
myVar =
getMonth(-1);
//retrieve the current value for a specific symbol
myVar =
getMonth(0sym("IBM") );
//retrieve the current value for a specific symbol/interval
myVar =
getMonth(0sym("IBM,5") );
//retrieve the current value for a specific bar interval
myVar =
getMonth(0inv(15) );
//create a Series Object of the month values.
xMonth =
getMonth();
//create a Series Object of the month values for a specific symbol.
xMonth =
getMonth( sym("IBM") );
//create a Series Object of the month values for a specific symbol/interval.
xMonth =
getMonth( sym("IBM,5") );
//create a Series Object of the month values for a specific interval.
xMonth =
getMonth( inv(15) );

}


See Also

Series Functions
eSignal Bulletin Board Search Engine
Help Guides and Tutorials