std::codecvt<InternT,ExternT,StateT>:: out, do_out

この codecvt ファセットが変換を定義していない場合、いかなる文字も変換されません。 to_next は to と等しく設定され、 state は変更されず、 std::codecvt_base::noconv が返されます。

do_out ( state, from, from + 1 , from_next, to, to_end, to_next ) は ok を返さなければならない

• この codecvt ファセットは basic_filebuf によって使用され、
• do_out ( state, from, from_end, from_next, to, to_end, to_next ) は ok を返す。ここで from ! = from_end である。

戻り値

型 std::codecvt_base::result の値であり、成功ステータスを以下のように示します：

非変換特殊化 std:: codecvt < char , char , std:: mbstate_t > は常に std::codecvt_base::noconv を返します。

注記

from <= from_end && to <= to_end であること、および state が初期シフト状態を表すか、シーケンス内の先行する文字の変換によって得られたものであることを要求します。

codecvt がN:M変換（例えばUTF-16からUTF-8への変換では、出力する外部文字を決定するために2つの内部文字が必要な場合がある）をサポートする一方で、 std::basic_filebuf が使用できるのは1:N変換を定義する codecvt ファセットのみです。つまり、ファイルへの書き込み時に一度に1つの内部文字を処理できる必要があります。

N:M変換を実行する際、この関数はすべてのソース文字を消費した後（ from_next == from_end ）に std::codecvt_base::partial を返す場合があります。これは変換を完了するために別の内部文字が必要であることを意味します（例：UTF-16からUTF-8に変換する際、ソースバッファの最後の文字が上位サロゲートである場合）。

state への影響は意図的に未指定とされています。標準ファセットでは、これは std:: wcsrtombs を呼び出す場合と同様にシフト状態を維持するために使用され、したがって最後に正常に変換された文字の後のシフト状態を反映するように更新されますが、ユーザー定義ファセットはこれを自由に使用して、例えば遭遇した特殊文字の数をカウントするなど、他の任意の状態を維持することができます。

例

#include <iostream>
#include <locale>
#include <string>
int main()
{
    std::locale::global(std::locale("en_US.utf8"));
    auto& f = std::use_facet<std::codecvt<wchar_t, char, std::mbstate_t>>(std::locale());
    std::wstring internal = L"z\u00df\u6c34\U0001f34c"; // L"zß水🍌"
    // 以下の処理はwstring_convertでも実装可能
    std::mbstate_t mb{}; // 初期シフト状態
    std::string external(internal.size() * f.max_length(), '\0'); 
    const wchar_t* from_next;
    char* to_next;
    f.out(mb, &internal[0], &internal[internal.size()], from_next,
              &external[0], &external[external.size()], to_next);
    // 簡潔さのためエラーチェックは省略
    external.resize(to_next - &external[0]);
    std::cout << "The string in narrow multibyte encoding: " << external << '\n';
}

The string in narrow multibyte encoding: zß水🍌

不具合報告

以下の動作変更の欠陥報告書は、以前に公開されたC++規格に対して遡及的に適用されました。

関連項目