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

This `struct` provides a namespace for enumerating the set of named error codes that may be returned by functions in the `baltzo` package that take a Zoneinfo string identifier as input. See `Enum` in the TYPES sub‐section for details.

== Synopsis

Declared in `<baltzo_errorcode.h>`

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

== Description

This class: * supports a complete set of _enumeration_ operations

* except for `bdex` serialization * is `const` _thread‐safe_ For terminology see `bsldoc_glossary`.

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/ErrorCode/Enum.adoc[`Enum`] 
| Error codes returned by `baltzo` time‐zone operations.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baltzo/ErrorCode/print.adoc[`print`] 
| Write the string representation of the specified enumeration `value` to the specified output `stream`, and return a reference to `stream`. Optionally specify an initial indentation `level`, whose absolute value is incremented recursively for nested objects. If `level` is specified, optionally specify `spacesPerLevel`, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by `level`). See `toAscii` for what constitutes the string representation of a `ErrorCode::Enum` value.
| xref:BloombergLP/baltzo/ErrorCode/toAscii.adoc[`toAscii`] 
| Return the non‐modifiable string representation corresponding to the specified enumeration `value`, if it exists, and a unique (error) string otherwise. The string representation of `value` matches its corresponding enumerator name with the "k_" prefix elided. For example: ` bsl::cout << ErrorCode::toAscii(ErrorCode::k_UNSUPPORTED_ID); ` will print the following on standard output: ` UNSUPPORTED_ID ` Note that specifying a `value` that does not match any of the enumerators will result in a string representation that is distinct from any of those corresponding to the enumerators, but is otherwise unspecified.
|===



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