[#BloombergLP-baltzo-TimeZoneUtil-loadLocalTimePeriod-00]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baltzo.adoc[baltzo]::xref:BloombergLP/baltzo/TimeZoneUtil.adoc[TimeZoneUtil]::loadLocalTimePeriod
:relfileprefix: ../../../
:mrdocs:

Load local‐time period attributes for `localTime`.

== Synopsis

Declared in `<baltzo_timezoneutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
loadLocalTimePeriod(
    xref:BloombergLP/baltzo/LocalTimePeriod.adoc[LocalTimePeriod]* result,
    xref:BloombergLP/baltzo/LocalDatetime.adoc[LocalDatetime] const& localTime);
----

== Description

Load, into the specified `result`, attributes characterizing the specified `localTime` (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 `localTime.timeZoneId()` was 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
| *localTime*
| local date‐time whose period attributes are loaded
|===


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