# std::vprint_unicode(std::ostream)

> C++ Atlas: `cppatlas.com/w/cpp/io/basic_ostream/vprint_unicode` | Source: https://en.cppreference.com/w/cpp/io/basic_ostream/vprint_unicode | Domain: Input/output | Standards: C++20, C++23, C++26

Format args according to the format string fmt, and writes the result to the output stream os. Behaves as FormattedOutputFunction of os, except that some details of error reporting differ.

## Official Specification Summary (cppreference)

```cpp
// Defined in header <ostream>

void vprint_unicode( std::ostream& os,
                     std::string_view fmt, std::format_args args ); // (since C++23)
```

Format `args` according to the format string `fmt`, and writes the result to the output stream `os`. Behaves as *FormattedOutputFunction* of `os`, except that some details of error reporting differ.

Performs the following operations in order:

1. First, the function constructs and checks the sentry object.
2. Initializes an automatic variable as if by `std::string out = std::vformat(os.getloc(), fmt, args);`.
3. Writes `out` to `os`:

  - If `os` refers to a terminal that is only capable of displaying Unicode via a native Unicode API, flushes `os` and writes `out` to the terminal using the native Unicode API.
  - Otherwise, inserts the character sequence `[out.begin(),` `out.end())` into `os`.

If writing to the terminal or inserting into `os` fails, calls `os.setstate(std::ios_base::badbit)`.

If `out` contains invalid Unicode code units when the native Unicode API is used, the behavior is undefined.

### Parameters

- `os` - output stream to insert data into
- `fmt` - an object that represents the format string. The format string consists of

  - ordinary characters (except `{` and `}`), which are copied unchanged to the output,
  - escape sequences `{{` and `}}`, which are replaced with `{` and `}` respectively in the output, and
  - replacement fields.

  Each replacement field has the following format:

  - `{` *arg-id* (optional) `}`    (1)
  - `{` *arg-id* (optional) `:` *format-spec* `}`    (2)

  1) replacement field without a format specification

  2) replacement field with a format specification

  - `arg-id` - specifies the index of the argument in `args` whose value is to be used for formatting; if it is omitted, the arguments are used in order.

    The *arg-id* s in a format string must all be present or all be omitted. Mixing manual and automatic indexing is an error.
  - `format-spec` - the format specification defined by the `std::formatter` specialization for the corresponding argument. Cannot start with `}`.

  - For basic types and standard string types, the format specification is interpreted as standard format specification.
  - For chrono types, the format specification is interpreted as chrono format specification.

  (since C++23):

  - For range types, the format specification is interpreted as range format specification.
  - For `std::pair` and `std::tuple`, the format specification is interpreted as tuple format specification.
  - For `std::thread::id` and `std::stacktrace_entry`, see thread id format specification and stacktrace entry format specification.
  - For `std::basic_stacktrace`, no format specifier is allowed.

  (since C++26):

  - For `std::filesystem::path`, see path format specification.

  - For other formattable types, the format specification is determined by user-defined `formatter` specializations.
- `args` - arguments to be formatted

### Exceptions

- `std::bad_alloc` on allocation failure.
- Propagate any exception thrown by any formatter, e.g. `std::format_error`, without regard to the value of `os.exceptions()` and without turning on `ios_base::badbit` in the error state of `os`.
- May throw `ios_base::failure` caused by `os.setstate(ios_base::badbit)` which is called if an insertion into `os` fails.

### Notes

If invoking the native Unicode API requires transcoding, the invalid code units are substituted with `U+FFFD` REPLACEMENT CHARACTER (see "The Unicode Standard - Core Specification", Chapter 3.9).

| Feature-test macro | Value | Std | Feature |
| --- | --- | --- | --- |
| `__cpp_lib_print` | `202207L` | (C++23) | Formatted output |
| `__cpp_lib_format` | `202207L` | (C++23) | Exposing `std::basic_format_string` |

### Example

> Note: This section is incomplete Reason: no example

### Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

| DR | Applied to | Behavior as published | Correct behavior |
| --- | --- | --- | --- |
| LWG 4044 | C++23 | the native Unicode API was always used if the terminal referred to by `os` can display Unicode | only used if the terminal can only use the native Unicode API to display Unicode |

### See also

- [`vprint_nonunicode(std::ostream)`](https://en.cppreference.com/w/cpp/io/basic_ostream/vprint_nonunicode) (C++23): outputs character data using type-erased argument representation (function)
- [`print(std::ostream)`](https://en.cppreference.com/w/cpp/io/basic_ostream/print) (C++23): outputs formatted representation of the arguments (function template)
- [`operator<<(std::basic_ostream)`](https://en.cppreference.com/w/cpp/io/basic_ostream/operator_ltlt2): inserts character data or insert into rvalue stream (function template)
- [`vprint_unicode`](https://en.cppreference.com/w/cpp/io/vprint_unicode) (C++23), [`vprint_unicode_buffered`](https://en.cppreference.com/w/cpp/io/vprint_unicode): prints to Unicode capable `stdout` or a file stream using type-erased argument representation (function)
- [`format`](https://en.cppreference.com/w/cpp/utility/format/format) (C++20): stores formatted representation of the arguments in a new string (function template)

### External links

|   |   |
| --- | --- |
| 1. | Unicode |
| 2. | The Unicode Standard Version 14.0 - Core Specification |

---
Attribution: content from https://en.cppreference.com/w/cpp/io/basic_ostream/vprint_unicode (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.