[#init-StartLogging]
= xref:init.adoc[init]::StartLogging
:relfileprefix: ../
:mrdocs:

Opens the debug log file and begins writing buffered log messages.

== Synopsis

Declared in `<init/common.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
StartLogging(xref:ArgsManager.adoc[ArgsManager] const& args);
----

== Return Value

`true` if logging started successfully, `false` otherwise.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *args*
| The parsed program arguments controlling how logging starts.
|===


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