[#BloombergLP-bsls-StackAddressUtil-formatCheapStack]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsls.adoc[bsls]::xref:BloombergLP/bsls/StackAddressUtil.adoc[StackAddressUtil]::formatCheapStack
:relfileprefix: ../../../
:mrdocs:

Load the specified `output` buffer having the specified `length` with the Bloomberg standard "cheapstack" contents as a null‐terminated string. On successfully obtaining the current call stack, this will be instructions on how to run the Bloomberg tool `showfunc.tsk` (with the optionally specified `taskname`, otherwise with an attempt to obtain the system‐specific process name) to get details of the current call stack where `formatCheapStack` was called. On failure, text indicating that the call stack was not obtainable will be written to `output`. If `length` is not long enough for the entire output it will be truncated. The behavior is undefined unless `0 <= length` and `output` has the capacity for at least `length` bytes.

== Synopsis

Declared in `<bsls_stackaddressutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
void
formatCheapStack(
    char* output,
    int length,
    char const* taskname = 0);
----


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