codecvt-enums.md

description	title	ms.date	f1_keywords	ms.assetid	helpviewer_keywords
Learn more about: <codecvt> enums	<codecvt> enums	11/04/2016	codecvt/std::codecvt_mode	46a8b073-01bc-46d3-b3d3-a8540f9422c1	std::codecvt_mode

<codecvt> enums

codecvt_mode Enumeration

Specifies configuration information for locale facets.

enum codecvt_mode {
    consume_header = 4,
    generate_header = 2,
    little_endian = 1
};

Remarks

The enumeration defines three constants that supply configuration information to the locale facets declared in <codecvt>. The distinct values are:

• consume_header, to consume an initial header sequence when reading a multibyte sequence and determine the endianness of the subsequent multibyte sequence to be read

• generate_header, to generate an initial header sequence when writing a multibyte sequence to advertise the endianness of the subsequent multibyte sequence to be written

• little_endian, to generate a multibyte sequence in little-endian order, as opposed to the default big-endian order

These constants can be ORed together in arbitrary combinations.

See also

<codecvt>