[#BloombergLP-ball-RecordFormatterOptions]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::RecordFormatterOptions
:relfileprefix: ../../
:mrdocs:

This class provides a value‐semantic type for representing options used to configure log record formatters. These options are supplemental to the format specification string and affect how certain fields in log records are rendered. Currently, the only supported option is `timezoneDefault`, which controls whether timestamps are displayed in UTC or local time.

== Synopsis

Declared in `<ball_recordformatteroptions.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class RecordFormatterOptions;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/RecordFormatterOptions/2constructor-02a.adoc[`RecordFormatterOptions`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/ball/RecordFormatterOptions/setTimezoneDefault.adoc[`setTimezoneDefault`] 
| Set the timezone default value attribute of this object to the specified `timezoneDefault`.
| xref:BloombergLP/ball/RecordFormatterOptions/timezoneDefault.adoc[`timezoneDefault`] 
| Return a non‐modifiable reference to the timezone default attribute of this object.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/operator_not_eq-037.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` objects do not have the same value, and `false` otherwise. Two `RecordFormatterOptions` objects do not have the same value if their `timezoneDefault` attributes do not have the same value.
| xref:BloombergLP/ball/operator_eq-045.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise. Two `RecordFormatterOptions` objects have the same value if their `timezoneDefault` attributes have the same value.
|===


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