名稱空間
變體
操作

mbsrtowcs, mbsrtowcs_s

來自 cppreference.com
< c‎ | string‎ | multibyte
在標頭檔案 <wchar.h> 中定義
(1)
size_t mbsrtowcs( wchar_t* dst, const char** src, size_t len, mbstate_t* ps );
(自 C95 起)
(直到 C99)
size_t mbsrtowcs( wchar_t *restrict dst, const char **restrict src, size_t len,
                  mbstate_t *restrict ps );
(C99 起)
errno_t mbsrtowcs_s( size_t *restrict retval,

                     wchar_t *restrict dst, rsize_t dstsz,
                     const char **restrict src, rsize_t len,

                     mbstate_t *restrict ps );
(2) (C11 起)
1) 將以 *ps 描述的轉換狀態開始的空終止多位元組字元序列從 *src 指向的陣列的第一個元素轉換為其寬字元表示。如果 dst 不為空,則轉換後的字元儲存在 dst 指向的 wchar_t 陣列的連續元素中。寫入目標陣列的寬字元不超過 len 個。每個多位元組字元都像透過呼叫 mbrtowc 進行轉換。轉換在以下情況下停止:
  • 多位元組空字元已轉換並存儲。*src 設定為空指標值,*ps 表示初始移位狀態。
  • 遇到無效的多位元組字元(根據當前 C 區域設定)。*src 設定為指向第一個未轉換的多位元組字元的開頭。
  • 下一個要儲存的寬字元將超過 len*src 設定為指向第一個未轉換的多位元組字元的開頭。如果 dst 是空指標,則不檢查此條件。
2)(1)相同,但:
  • 函式將其結果作為輸出引數 retval 返回
  • 如果在寫入 len 個寬字元後,沒有空字元寫入 dst,則將 L'\0' 儲存在 dst[len] 中,這意味著總共寫入 len+1 個寬字元
  • 函式從終止空字元到 dstsz 處覆蓋目標陣列
  • 如果 srcdst 重疊,則行為未指定。
  • 在執行時檢測到以下錯誤並呼叫當前安裝的約束處理程式函式
  • retvalpssrc*src 為空指標
  • dstszlen 大於 RSIZE_MAX/sizeof(wchar_t)(除非 dst 為空)
  • dstsz不為零(除非dst為空)
  • *src 陣列的前 dstsz 個多位元組字元中沒有空字元,並且 len 大於 dstsz(除非 dst 為空)
與所有邊界檢查函式一樣,只有當實現定義了 __STDC_LIB_EXT1__ 且使用者在包含 <wchar.h> 之前將 __STDC_WANT_LIB_EXT1__ 定義為整數常量 1 時,才能保證 mbsrtowcs_s 可用。

目錄

[編輯] 引數

dst - 指向寬字元陣列的指標,結果將儲存在此處
src - 指向空終止多位元組字串的第一個元素的指標的指標
len - dst指向的陣列中可用的寬字元數
ps - 指向轉換狀態物件的指標
dstsz - 將寫入的最大寬字元數(dst 陣列的大小)
retval - 指向一個size_t物件的指標,結果將儲存在此處

[編輯] 返回值

1) 成功時,返回寫入字元陣列的寬字元數,不包括終止空字元 L'\0'。如果 dst 是空指標,則返回在無限長度下本應寫入的寬字元數。在轉換錯誤時(如果遇到無效的多位元組字元),返回 (size_t)-1,將 EILSEQ 儲存在 errno 中,並使 *ps 處於未指定狀態。
2) 成功時返回零(在這種情況下,不包括終止零的寬字元數,已寫入或將寫入 dst,儲存在 *retval 中),錯誤時返回非零。在執行時約束衝突的情況下,將 (size_t)-1 儲存在 *retval 中(除非 retval 為空),並將 dst[0] 設定為 L'\0'(除非 dst 為空或 dstmax 為零或大於 RSIZE_MAX

[編輯] 示例

#include <stdio.h>
#include <locale.h>
#include <wchar.h>
#include <string.h>
 
void print_as_wide(const char* mbstr)
{
    mbstate_t state;
    memset(&state, 0, sizeof state);
    size_t len = 1 + mbsrtowcs(NULL, &mbstr, 0, &state);
    wchar_t wstr[len];
    mbsrtowcs(&wstr[0], &mbstr, len, &state);
    wprintf(L"Wide string: %ls \n", wstr);
    wprintf(L"The length, including L'\\0': %zu\n", len);
}
 
int main(void)
{
    setlocale(LC_ALL, "en_US.utf8");
    print_as_wide(u8"z\u00df\u6c34\U0001f34c"); // u8"zß水🍌"
}

輸出

Wide string: zß水🍌
The length, including L'\0': 5

[編輯] 參考

  • C11 標準 (ISO/IEC 9899:2011)
  • 7.29.6.4.1 mbsrtowcs 函式 (p: 445)
  • K.3.9.3.2.1 mbsrtowcs_s 函式 (p: 648-649)
  • C99 標準 (ISO/IEC 9899:1999)
  • 7.24.6.4.1 mbsrtowcs 函式 (p: 391)

[編輯] 另請參閱

將窄多位元組字元字串轉換為寬字串
(函式) [編輯]
將下一個多位元組字元轉換為寬字元,給定狀態
(函式) [編輯]
將寬字串轉換為窄多位元組字元字串,給定狀態
(函式) [編輯]
C++ 文件 for mbsrtowcs