year()

ICE Data Services -

year() Series Functions


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

 

Syntax

year( [ 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 year 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 =
year(0);
//retrieve the value for the previous price bar
myVar =
year(-1);
//retrieve the current value for a specific symbol
myVar =
year(0sym("IBM") );
//retrieve the current value for a specific symbol/interval
myVar =
year(0sym("IBM,5") );
//retrieve the current value for a specific bar interval
myVar =
year(0inv(15) );
//create a Series Object of the year values.
xYear =
year();
//create a Series Object of the year values for a specific symbol.
xYear =
year( sym("IBM") );
//create a Series Object of the year values for a specific symbol/interval.
xYear =
year( sym("IBM,5") );
//create a Series Object of the year values for a specific interval.
xYear =
year( inv(15) );

}


See Also

Series Functions
eSignal Bulletin Board Search Engine
Help Guides and Tutorials