1. EFS
  2. Function Reference
  3. Series Functions

hlc3()

ICE Data Services -

hlc3()
Previous  Top  Next

         The hlc3() function creates a series based on (high+low+close)/3 or retrieves individual (high+low+close)/3 values.
Syntax

hlc3( [ 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 close values. n/a

Return Value(s)

Returns a Series Object when nBarIndex is not specified.

Returns a single price value when nBarIndex is specified.


Notes

N/A


Code Examples
function main() {
	
	//retrieve the value for the current price bar
 	myVar = hlc3(0);
	//retrieve the value for the previous price bar
 	myVar = hlc3(-1);
	//retrieve the current value for a specific symbol
 	myVar = hlc3(0, sym("IBM"));
	//retrieve the current value for a specific symbol/interval
 	myVar = hlc3(0, sym("IBM,5"));
	//retrieve the current value for a specific bar interval
 	myVar = hlc3(0, inv(15));
	//create a Series Object of the (high+low+close)/3 prices.
 	xSeries = hlc3();
	//create a Series Object of the (high+low+close)/3 prices for a specific symbol.
 	xSeries = hlc3(sym("IBM"));
	//create a Series Object of the (high+low+close)/3 prices for a specific symbol/interval.
 	xSeries = hlc3(sym("IBM,5"));
 	//create a Series Object of the (high+low+close)/3 prices for a specific interval.
 	xSeries = hlc3(inv(15));
 
}
 
See Also

hl2()
oc2()
ohlc4()
hlcc4()