[#bsl-emit_on_flush]
= xref:bsl.adoc[bsl]::emit_on_flush
:relfileprefix: ../
:mrdocs:

Enable emit‐on‐flush for a `basic_syncbuf` backing `stream`.

== Synopsis

Declared in `<bslstl_ostream.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class CHAR,
    class TRAITS>
basic_ostream<CHAR, TRAITS>&
emit_on_flush(basic_ostream<CHAR, TRAITS>& stream);
----

== Description

If, for the specified `stream`, `stream.rdbuf()` is a `basic_syncbuf<CHAR,TRAITS,ALLOCATOR>`, make `stream` emit (i.e., transmit data to the wrapped stream buffer) when flushed, otherwise has no effect. Return `stream`.

== Return Value

a reference to `stream`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *stream*
| output stream that may wrap a `basic_syncbuf`
|===


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