Configure a "text" scheme formatter and load it into output.

Synopsis

Declared in <ball_recordstringformatter.h>

static
int
loadTextSchemeFormatter(
    RecordFormatterFunctor::Type* output,
    std::string_view const& format,
    RecordFormatterOptions const& formatOptions);

Description

This class method configures a formatter for the "text" scheme using the specified format and formatOptions and if successful loads it into the specified output and returns zero. In case configuration fails a non‐zero value is returned and output is loaded with a string formatter of the default format configuration ` "n%d %p:%t %s %f:%l %c %m %un" `

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

output

destination for the configured formatter functor

format

printf‐style format specification for the text scheme

formatOptions

options that control formatter configuration

Created with MrDocs