[#BloombergLP-baltzo-ZoneinfoBinaryReader-read-05]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baltzo.adoc[baltzo]::xref:BloombergLP/baltzo/ZoneinfoBinaryReader.adoc[ZoneinfoBinaryReader]::read
:relfileprefix: ../../../
:mrdocs:

Read well‐formed time zone information from a binary stream.

== Synopsis

Declared in `<baltzo_zoneinfobinaryreader.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
read(
    xref:BloombergLP/baltzo/Zoneinfo.adoc[Zoneinfo]* zoneinfoResult,
    std::istream& stream);
----

== Description

Read time zone information from the specified `stream`, and load the description into the specified `zoneinfoResult`. The `zoneinfoResult` will have a sentinel transition at 01‐01‐001, meeting the first two requirements for a "well‐formed" object (see `baltzo::ZoneinfoUtil::isWellFormed` documentation). Return 0 on success and a non‐zero value if `stream` does not provide a sequence of bytes consistent with the Zoneinfo binary format. If an error occurs during the operation, `zoneinfoResult` is unspecified. Optionally specify a `headerResult` that, on success, will be populated with a summary of the `stream` contents.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *zoneinfoResult*
| receives the loaded time zone information
| *stream*
| binary input stream providing Zoneinfo data
|===


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