[#FormatScript]
= FormatScript
:mrdocs:

Format a script as a compact single&hyphen;line string for logging and display&period;

== Synopsis

Declared in `&lt;core&lowbar;io&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::string
FormatScript(xref:CScript.adoc[CScript] const& script);
----

== Return Value

The formatted script text&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *script*
| Script to format&period;
|===


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