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

Convert `utcTime` to local time in `resultTimeZoneId`.

== Synopsis

Declared in `<baltzo_timezoneutilimp.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
convertUtcToLocalTime(
    xref:BloombergLP/bdlt/DatetimeTz.adoc[bdlt::DatetimeTz]* result,
    char const* resultTimeZoneId,
    xref:BloombergLP/bdlt/Datetime.adoc[bdlt::Datetime] const& utcTime,
    xref:BloombergLP/baltzo/ZoneinfoCache.adoc[ZoneinfoCache]* cache);
----

== Description

Load, into the specified `result`, the local date‐time value, in the time zone indicated by the specified `resultTimeZoneId`, corresponding to the specified `utcTime`, 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 `resultTimeZoneId` is not recognized, and a return status of `ErrorCode::k_OUT_OF_RANGE` indicates that an out of range value of `result` would have occurred.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| receives the converted local date‐time
| *resultTimeZoneId*
| identifier of the destination time zone
| *utcTime*
| UTC date‐time to convert
| *cache*
| zoneinfo cache supplying time zone data
|===


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