[#BloombergLP-bdlt-LocalTimeOffset]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::LocalTimeOffset
:relfileprefix: ../../
:mrdocs:

This `struct` provides a namespace for local‐time‐offset procedures including a configurable global callback mechanism. The use of these procedures is thread‐safe (see `Thread Safety`).

== Synopsis

Declared in `<bdlt_localtimeoffset.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct LocalTimeOffset;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/LocalTimeOffset/LocalTimeOffsetCallback-08.adoc[`LocalTimeOffsetCallback`] 
| `LocalTimeOffsetCallback` is an alias for the type of a function that returns a `bsls::TimeInterval` value representing the difference between local time and UTC time at the specified `utcDatetime`. This function must be thread‐safe in multi‐threaded builds. Note that the installed callback function must have geographic information specifying the local timezone.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/LocalTimeOffset/localTimeOffset.adoc[`localTimeOffset`] 
| Return a `bsls::TimeInterval` value representing the difference between local time and UTC time at the specified `utcDatetime`. This method uses the currently installed local‐time‐offset callback mechanism.
| xref:BloombergLP/bdlt/LocalTimeOffset/localTimeOffsetCallback-04.adoc[`localTimeOffsetCallback`] 
| Return the currently installed `LocalTimeOffsetCallback` function.
| xref:BloombergLP/bdlt/LocalTimeOffset/localTimeOffsetDefault.adoc[`localTimeOffsetDefault`] 
| Return a `bsls::TimeInterval` value representing the difference between local time and UTC time at the specified `utcDatetime`. Note that the local time zone is determined by the `TZ` environment variable in the same manner as the `localtime` POSIX function.
| xref:BloombergLP/bdlt/LocalTimeOffset/setLocalTimeOffsetCallback.adoc[`setLocalTimeOffsetCallback`] 
| Set the specified `callback` as the function to be used to return a `bsls::TimeInterval` value representing the difference between local time and UTC time at a specified UTC date and time. Return the previously installed `LocalTimeOffsetCallback` function. The behavior is undefined unless `0 != callback`.
|===



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