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

This struct provides a namespace for functions that manage and access the default time‐zone data cache.

== Synopsis

Declared in `<baltzo_defaultzoneinfocache.h>`

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

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/DefaultZoneinfoCache/defaultCache.adoc[`defaultCache`] 
| Return the default `ZoneinfoCache` object for this process if the optionally specified `cache` is 0, and `cache` otherwise. If `cache` is 0, and the default Zoneinfo cache object has not been set ‐‐ either explicitly with a call to `setDefaultCache`, or implicitly through a prior call to this method ‐‐ then initialize a new `ZoneinfoCache` object, set the default cache object to the newly created object, and return its address.
| xref:BloombergLP/baltzo/DefaultZoneinfoCache/defaultZoneinfoDataLocation.adoc[`defaultZoneinfoDataLocation`] 
| Return a null terminated (C‐style) string describing the default file‐system path of the (expected) root of the Zoneinfo Database time‐zone information files. The returned string will be the current value of the `BDE_ZONEINFO_ROOT_PATH` environment variable, if set, or else one of a (priority ordered) sequence of (platform‐specific) standard directories, if one of those directories exists and contains a sub‐set of expected files, and the current directory, otherwise. The behavior is undefined if the returned address is dereferenced after a subsequent call to the `putenv` POSIX function to set the `BDE_ZONEINFO_ROOT_PATH` environment variable.
| xref:BloombergLP/baltzo/DefaultZoneinfoCache/loadDefaultZoneinfoDataLocations-06.adoc[`loadDefaultZoneinfoDataLocations`] 
| `loadDefaultZoneinfoDataLocations` overloads
| xref:BloombergLP/baltzo/DefaultZoneinfoCache/setDefaultCache.adoc[`setDefaultCache`] 
| Set the address of the default `ZoneinfoCache` object to the specified `cache`. Return the address of the default cache object that was set by a previous call to this method, or 0 if no call to this method was previously executed. The behavior is undefined unless (1) `cache` remains valid until the last operation is performed on this process's default cache, or a subsequent call to `setDefaultCache`, and (2) this method is _not_ called from one thread while another thread is attempting to access the default time zone cache instance (i.e., this method is _not_ thread‐safe). Note that this method is intended for use _only_ by the _owner_ of `main` (and for testing purposes) where the caller affirmatively takes responsibility for the behavior of all clients of the default time zone cache.
|===



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