public method PriceHistoryHelperAut.GetCandle

Brief

Gets the start and end dates of the candle to which a specified date belongs.

Declaration
Visual Basic
Sub GetCandle (dt as DateTime, sPeriodID as String, dayOffset as Integer, weekOffset as Integer, byRef dtCandleStart as Variant, byRef dtCandleEnd as Variant)
IDL
[id(2)] HRESULT GetCandle( [in]DATE dtTime, [in]BSTR sPeriodID, [in]int iDayOffset, [in]int iWeekOffset, [out]VARIANT *pvCandleStart, [out]VARIANT *pvCandleEnd)

Parameters
dt

The date and time.
sPeriodID

The identifier of the period.
dayOffset

The offset between a day's midnight and the date of the beginning of a trading day. For example, FXCM's trading day starts at 17:00 of yesterday, so the offset is -7 hours.

To receive the value, use the method GetTradingDayOffset or GetTradingDayOffsetUTC.
weekOffset

The offset between a Sunday date and the date of the beginning of a trading week. For example, FXCM's trading week starts at Saturday, so the offset is -1 day.

To receive the value, use the GetTradingWeekOffset method.
dtCandleStart

[output] The date and time when the candle starts.
dtCandleEnd

[output] The date and time when the candle ends.

Details

The GetCandle method is defined in the PriceHistoryHelperAut class.

back