[#BloombergLP-bslfmt-PadUtil-pad-0d]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::xref:BloombergLP/bslfmt/PadUtil.adoc[PadUtil]::pad
:relfileprefix: ../../../
:mrdocs:

`pad` overloads

== Synopses

Declared in `&lt;bslfmt&lowbar;padutil&period;h&gt;`

Write `padWidth` copies of a single&hyphen;character `filler` through `out`&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class t&lowbar;ITERATOR&gt;
static
t&lowbar;ITERATOR
xref:BloombergLP/bslfmt/PadUtil/pad-07.adoc[pad](
    t&lowbar;ITERATOR out,
    std::ptrdiff&lowbar;t padWidth,
    char filler);
----

[.small]#xref:BloombergLP/bslfmt/PadUtil/pad-07.adoc[_» more&period;&period;&period;_]#

Write `padWidth` copies of a single wide&hyphen;character `filler` through `out`&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class t&lowbar;ITERATOR&gt;
static
t&lowbar;ITERATOR
xref:BloombergLP/bslfmt/PadUtil/pad-02c.adoc[pad](
    t&lowbar;ITERATOR out,
    std::ptrdiff&lowbar;t padWidth,
    wchar&lowbar;t filler);
----

[.small]#xref:BloombergLP/bslfmt/PadUtil/pad-02c.adoc[_» more&period;&period;&period;_]#

Write `filler` to `out` the specified `padWidth` times&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class t&lowbar;ITERATOR&gt;
static
t&lowbar;ITERATOR
xref:BloombergLP/bslfmt/PadUtil/pad-01.adoc[pad](
    t&lowbar;ITERATOR out,
    std::ptrdiff&lowbar;t padWidth,
    std::string&lowbar;view const& filler);
----

[.small]#xref:BloombergLP/bslfmt/PadUtil/pad-01.adoc[_» more&period;&period;&period;_]#

Write a wide&hyphen;string `filler` to `out` the specified `padWidth` times&period;


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class t&lowbar;ITERATOR&gt;
static
t&lowbar;ITERATOR
xref:BloombergLP/bslfmt/PadUtil/pad-020.adoc[pad](
    t&lowbar;ITERATOR out,
    std::ptrdiff&lowbar;t padWidth,
    std::wstring&lowbar;view const& filler);
----

[.small]#xref:BloombergLP/bslfmt/PadUtil/pad-020.adoc[_» more&period;&period;&period;_]#

== Return Value

the output iterator after writing the filler repetitions

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| output iterator receiving the filler repetitions
| *padWidth*
| number of times to write `filler`&semi; no output if `&lt; 0`
| *filler*
| single character written as each padding unit
|===


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