[#BloombergLP-baltzo-TimeZoneUtil-convertLocalToUtc-0b]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baltzo.adoc[baltzo]::xref:BloombergLP/baltzo/TimeZoneUtil.adoc[TimeZoneUtil]::convertLocalToUtc
:relfileprefix: ../../../
:mrdocs:

Convert `localTime` in `timeZoneId` to a UTC date‐time.

== Synopsis

Declared in `<baltzo_timezoneutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
convertLocalToUtc(
    xref:BloombergLP/bdlt/Datetime.adoc[bdlt::Datetime]* result,
    xref:BloombergLP/bdlt/Datetime.adoc[bdlt::Datetime] const& localTime,
    char const* timeZoneId,
    xref:BloombergLP/baltzo/DstPolicy/Enum.adoc[DstPolicy::Enum] dstPolicy = DstPolicy::e_UNSPECIFIED);
----

== Description

Load, into the specified `result`, the UTC time value that corresponds to the specified `localTime` in the time zone indicated by the specified `timeZoneId`. Optionally specify a `dstPolicy` indicating whether or not `localTime` represents a daylight‐saving time value. If `dstPolicy` is unspecified and `localTime` is a unique and valid time in the source time zone, then perform the conversion using that uniquely described time; if `dstPolicy` is unspecified and `localTime` is either ambiguous or invalid, then use the later of the two possible interpretations of `localTime`. The offset from UTC of the time zone is rounded down to minute precision. 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. The behavior is undefined unless the result of the conversion falls within the supported epoch.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| receives the corresponding UTC date‐time
| *localTime*
| local date‐time to convert
| *timeZoneId*
| identifier of the time zone for `localTime`
| *dstPolicy*
| daylight‐saving policy for interpreting `localTime`
|===


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