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

Namespace for utility functions that simplify logger&hyphen;manager usage&period;

== Synopsis

Declared in `&lt;ball&lowbar;log&period;h&gt;`

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

== Description

This `struct` provides a namespace for a suite of utility functions that simplify usage of the `ball&lowbar;loggermanager` component&period; The direct use of these utility functions is _strongly_ discouraged&period;

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/Log/categoryHolderIfEnabled.adoc[`categoryHolderIfEnabled`] 
| Return the specified `categoryHolder` if the severity warrants logging according to the specified `t&lowbar;SEVERITY` and `categoryHolder`, and 0 otherwise&period;
| xref:BloombergLP/ball/Log/format.adoc[`format`] 
| Format a `printf`&hyphen;style message into the specified buffer&period;
| xref:BloombergLP/ball/Log/getRecord.adoc[`getRecord`] 
| Return a modifiable record with the specified file and line&period;
| xref:BloombergLP/ball/Log/isCategoryEnabled.adoc[`isCategoryEnabled`] 
| Return whether logging is enabled for the category at the severity&period;
| xref:BloombergLP/ball/Log/logMessage-02.adoc[`logMessage`] 
| `logMessage` overloads
| xref:BloombergLP/ball/Log/obtainMessageBuffer-0c.adoc[`obtainMessageBuffer`] 
| `obtainMessageBuffer` overloads
| xref:BloombergLP/ball/Log/releaseMessageBuffer.adoc[`releaseMessageBuffer`] 
| Unlock the mutex that guards this thread&apos;s message buffer&period;
| xref:BloombergLP/ball/Log/setCategory-0b.adoc[`setCategory`] 
| `setCategory` overloads
| xref:BloombergLP/ball/Log/setCategoryHierarchically-0b.adoc[`setCategoryHierarchically`] 
| `setCategoryHierarchically` overloads
|===



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