[#BloombergLP-baltzo-TimeZoneUtilImp-loadLocalTimePeriodForUtc]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baltzo.adoc[baltzo]::xref:BloombergLP/baltzo/TimeZoneUtilImp.adoc[TimeZoneUtilImp]::loadLocalTimePeriodForUtc
:relfileprefix: ../../../
:mrdocs:

Load local‐time period attributes for `utcTime` in `timeZoneId`.

== Synopsis

Declared in `<baltzo_timezoneutilimp.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
loadLocalTimePeriodForUtc(
    xref:BloombergLP/baltzo/LocalTimePeriod.adoc[LocalTimePeriod]* result,
    char const* timeZoneId,
    xref:BloombergLP/bdlt/Datetime.adoc[bdlt::Datetime] const& utcTime,
    xref:BloombergLP/baltzo/ZoneinfoCache.adoc[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

[cols="1,4"]
|===
| 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
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#