BloombergLP::baltzo::TimeZoneUtil::addInterval

Add interval to originalTime in its local time zone.

Synopsis

Declared in <baltzo_timezoneutil.h>

static
int
addInterval(
    LocalDatetime* result,
    LocalDatetime const& originalTime,
    bsls::TimeInterval const& interval);

Description

Load, into the specified result, the local time value that is the specified interval in the future of the specified originalTime (in the time zone originalTime.timeZoneId()). Return 0 on success, and a non-zero value with no effect otherwise. A return value of ErrorCode::k_UNSUPPORTED_ID indicates that targetTimeZoneId was not recognized, and a return value of ErrorCode::k_OUT_OF_RANGE indicates that the result of the operation would have been outside the range of values representable by the result type. The resulting local-time is equivalent to adding interval to originalTime.datetimeTz().utcDatetime() and converting the result into the local time of originalTime.timeZoneId().

Return Value

0 on success, and a non-zero value otherwise

Parameters

NameDescription
resultreceives the local time after adding interval
originalTimelocal time from which to start
intervaltime interval to add to originalTime