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

Write `padWidth` copies of a single wide‐character `filler` through `out`.

== Synopsis

Declared in `<bslfmt_padutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_ITERATOR>
static
t_ITERATOR
pad(
    t_ITERATOR out,
    std::ptrdiff_t padWidth,
    wchar_t filler);
----

== 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`; no output if `< 0`
| *filler*
| single wide character written as each padding unit
|===


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