Load local‐time period attributes for utcTime in timeZoneId.

Synopsis

Declared in <baltzo_timezoneutilimp.h>

static
int
loadLocalTimePeriodForUtc(
    LocalTimePeriod* result,
    char const* timeZoneId,
    bdlt::Datetime const& utcTime,
    ZoneinfoCache* cache);

Description

Load, into the specified result, attributes characterizing local time at the specified utcTime in the time zone indicated by the specified timeZoneId (e.g., the offset from UTC, whether it is daylight‐saving time), as well as the time interval over which those attributes apply, using time zone information supplied by the specified cache. Return 0 on success, and a non‐zero value otherwise. A return status of ErrorCode::k_UNSUPPORTED_ID indicates that timeZoneId is not recognized.

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

result

receives the local‐time period attributes

timeZoneId

time zone identifier

utcTime

UTC datetime to characterize

cache

zoneinfo cache supplying time zone data

Created with MrDocs