std::codecvt_utf16

定義於標頭檔案 `<codecvt>`
template< class Elem, unsigned long Maxcode = 0x10ffff, std::codecvt_mode Mode = (std::codecvt_mode)0 > class codecvt_utf16 : public std::codecvt<Elem, char, std::mbstate_t>;		(C++11 起) (C++17 中已棄用) (C++26 中移除)

std::codecvt_utf16 是一個 std::codecvt facet，它封裝了 UTF-16 編碼位元組字串與 UCS-2 或 UTF-32 字元字串（取決於 Elem 的型別）之間的轉換。此 std::codecvt facet 可用於以二進位制模式讀寫 UTF-16 檔案。

UCS-2 是一種過時的編碼，是 UTF-16 的子集，僅編碼範圍 U+0000-U+FFFF (基本多語言平面) 中的標量值。

std::codecvt_utf16::codecvt_utf16

explicit codecvt_utf16( std::size_t refs = 0 );

構造一個新的 std::codecvt_utf16 facet，將初始引用計數器 refs 傳遞給基類。

引數

refs

-

連結到 facet 的引用計數

std::codecvt_utf16::~codecvt_utf16

~codecvt_utf16();

銷燬 facet。與區域設定管理的 facet 不同，此 facet 的解構函式是公共的。

繼承自 std::codecvt

巢狀型別

型別	定義
`intern_type`	`internT`
`extern_type`	`externT`
`state_type`	`stateT`

[編輯] 資料成員

成員	描述
std::locale::id `id` [static]	facet 的識別符號

成員函式

out	呼叫 `do_out` (`std::codecvt<InternT,ExternT,StateT>` 的公共成員函式) [編輯]
in	呼叫 `do_in` (`std::codecvt<InternT,ExternT,StateT>` 的公共成員函式) [編輯]
unshift	呼叫 `do_unshift` (`std::codecvt<InternT,ExternT,StateT>` 的公共成員函式) [編輯]
encoding	呼叫 `do_encoding` (`std::codecvt<InternT,ExternT,StateT>` 的公共成員函式) [編輯]
always_noconv	呼叫 `do_always_noconv` (`std::codecvt<InternT,ExternT,StateT>` 的公共成員函式) [編輯]
length	呼叫 `do_length` (`std::codecvt<InternT,ExternT,StateT>` 的公共成員函式) [編輯]
max_length	呼叫 `do_max_length` (`std::codecvt<InternT,ExternT,StateT>` 的公共成員函式) [編輯]

受保護的成員函式

do_out [虛擬函式]	將字串從 `InternT` 轉換為 `ExternT`，例如寫入檔案時 (`std::codecvt<InternT,ExternT,StateT>` 的虛保護成員函式) [編輯]
do_in [虛擬函式]	將字串從 `ExternT` 轉換為 `InternT`，例如從檔案讀取時 (`std::codecvt<InternT,ExternT,StateT>` 的虛保護成員函式) [編輯]
do_unshift [虛擬函式]	為不完全轉換生成 `ExternT` 字元的終止字元序列 (`std::codecvt<InternT,ExternT,StateT>` 的虛保護成員函式) [編輯]
do_encoding [虛擬函式]	如果為常量，則返回生成一個 `InternT` 字元所需的 `ExternT` 字元數 (`std::codecvt<InternT,ExternT,StateT>` 的虛保護成員函式) [編輯]
do_always_noconv [虛擬函式]	測試此 facet 是否為所有有效引數值編碼一個同一性轉換 (`std::codecvt<InternT,ExternT,StateT>` 的虛保護成員函式) [編輯]
do_length [虛擬函式]	計算將由轉換為給定 `InternT` 緩衝區消耗的 `ExternT` 字串的長度 (`std::codecvt<InternT,ExternT,StateT>` 的虛保護成員函式) [編輯]
do_max_length [虛擬函式]	返回可轉換為單個 `InternT` 字元的最大 `ExternT` 字元數 (`std::codecvt<InternT,ExternT,StateT>` 的虛保護成員函式) [編輯]

繼承自 std::codecvt_base

巢狀型別	定義
enum result { ok, partial, error, noconv };	無作用域列舉型別

列舉常量	定義
`ok`	轉換完成，無錯誤
`部分`	並非所有源字元都已轉換
`error`	遇到無效字元
`noconv`	無需轉換，輸入和輸出型別相同

[編輯] 注意

儘管標準要求此 facet 在 Elem 大小為 16 位時與 UCS-2 配合使用，但某些實現使用 UTF-16 代替，這使其成為非轉換區域設定。術語 "UCS-2" 已被棄用並從 ISO 10646 中刪除。

[編輯] 示例

以下示例演示了在具有 32 位 wchar_t 的系統上解碼 UTF-16le 檔案。在具有 16 位 wchar_t 的系統上，第三個字元的解碼將失敗，因為 std::codecvt_utf16<char16_t> 生成的是 UCS-2，而不是 UTF-16。

執行此程式碼

#include <codecvt>
#include <cwchar>
#include <fstream>
#include <iostream>
#include <locale>
#include <string>
 
void prepare_file()
{
    // UTF-16le data (if host system is little-endian)
    char16_t utf16le[4] = {0x007a,          // latin small letter 'z' U+007a
                           0x6c34,          // CJK ideograph "water"  U+6c34
                           0xd834, 0xdd0b}; // musical sign segno U+1d10b    
 
    // store in a file
    std::ofstream fout("text.txt");
    fout.write(reinterpret_cast<char*>(utf16le), sizeof utf16le);
}
 
int main()
{
    prepare_file();
    // open as a byte stream
    std::wifstream fin("text.txt", std::ios::binary);
    // apply facet
    fin.imbue(std::locale(fin.getloc(),
        new std::codecvt_utf16<wchar_t, 0x10ffff, std::little_endian>));
 
    wchar_t c = 0;
    for (std::cout << std::showbase << std::hex; fin.get(c);
         std::cout << static_cast<std::wint_t>(c) << '\n');
}

輸出

0x7a
0x6c34
0x1d10b

[編輯] 缺陷報告

下列更改行為的缺陷報告追溯地應用於以前出版的 C++ 標準。

缺陷報告	應用於	釋出時的行為	正確的行為
LWG 2229	C++98	建構函式和解構函式未指定	指定它們

[編輯] 另請參閱

字元轉換	由區域設定定義的多位元組 (UTF-8, GB18030)	UTF-8	UTF-16
UTF-16	`mbrtoc16` / `c16rtomb` (帶 C11 的 DR488)	`codecvt`<char16_t,char,mbstate_t> `codecvt_utf8_utf16`<char16_t> `codecvt_utf8_utf16`<char32_t> `codecvt_utf8_utf16`<wchar_t>	不適用
UCS-2	`c16rtomb` (不帶 C11 的 DR488)	`codecvt_utf8`<char16_t>	`codecvt_utf16`<char16_t>
UTF-32	`mbrtoc32` / `c32rtomb`	`codecvt`<char32_t,char,mbstate_t> `codecvt_utf8`<char32_t>	`codecvt_utf16`<char32_t>
系統 wchar_t UTF-32 (非 Windows) UCS-2 (Windows)	`mbsrtowcs` / `wcsrtombs` `use_facet`<`codecvt` <wchar_t,char,mbstate_t>>(`locale`)	`codecvt_utf8`<wchar_t>	`codecvt_utf16`<wchar_t>

codecvt	在字元編碼之間轉換，包括 UTF-8、UTF-16、UTF-32 (類模板) [編輯]
codecvt_mode (C++11)(C++17 中已棄用)(C++26 中已移除)	用於改變標準 codecvt 刻面行為的標籤 (列舉) [編輯]
codecvt_utf8 (C++11)(C++17 中已棄用)(C++26 中已移除)	在 UTF-8 和 UCS-2/UCS-4 之間轉換 (類模板) [編輯]
codecvt_utf8_utf16 (C++11)(C++17 中已棄用)(C++26 中已移除)	在 UTF-8 和 UTF-16 之間轉換 (類模板) [編輯]

編譯器支援
自由（freestanding）與宿主（hosted）
語言
標準庫
標準庫標頭檔案
具名要求
特性測試宏 (C++20)
語言支援庫
概念庫 (C++20)
診斷庫
記憶體管理庫
超程式設計庫 (C++11)
通用工具庫
容器庫
迭代器庫
範圍庫 (C++20)
演算法庫
字串庫
文字處理庫
數值庫
日期和時間庫
輸入/輸出庫
檔案系統庫 (C++17)
併發支援庫 (C++11)
執行控制庫 (C++26)
技術規範
符號索引
外部庫

(建構函式)	構造一個新的 `codecvt_utf16` facet (公開成員函式)
(解構函式)	銷燬一個 `codecvt_utf16` facet (公開成員函式)

cppreference.com

名稱空間

變體

檢視

操作