BloombergLP::baltzo::TimeZoneUtil::loadLocalTimePeriod

Load local-time period attributes for localTime in timeZoneId.

Synopsis

Declared in <baltzo_timezoneutil.h>

static
int
loadLocalTimePeriod(
    LocalTimePeriod* result,
    bdlt::DatetimeTz const& localTime,
    char const* timeZoneId);

Description

Load, into the specified result, attributes characterizing the specified localTime in the time zone indicated by the specified timeZoneId (i.e., the offset from UTC, whether daylight-saving time is in effect and the description of the time zone), as well as the time interval over which those attributes apply. Return 0 on success, and a non-zero value with no effect otherwise. A return value of ErrorCode::k_UNSUPPORTED_ID indicates that timeZoneId was not recognized.

Return Value

0 on success, and a non-zero value otherwise

Parameters

NameDescription
resultreceives the local-time period attributes
localTimelocal date-time whose period attributes are loaded
timeZoneIdidentifier of the time zone for localTime