# std::mbrlen

< cpp‎ | string‎ | multibyte

定义于头文件 `<cwchar>` |  |
std::size_t mbrlen( const char* s, std::size_t n, std::mbstate_t* ps); |  |

给定当前转换状态 `s` ，确定首字节为 `ps` 所指向的多字节字符的剩余字节大小。

此函数等价于对于某 std::mbstate_t 类型的隐藏对象 `internal` 的调用 std::mbrtowc(nullptr, s, n, ps?ps:&internal) ，除了只求值表达式 `ps` 一次。

### 参数

s | - | 指向多字节字符串元素的指针
n | - | s 中能检验的字节数限制
ps | - | 指向保有转换状态的对象的指针

### 返回值

若下 `n` 个或更少字节完成空字符则为 ​0​ 。

完成合法多字节字符的字节数（ 1 与 n 之间）。

若发生编码错误则为 (size_t)-1 。

若下 `n` 个字节为可能合法，而在检验全部 `n` 个字节后仍不完整的多字节字符的一部分，则为 (size_t)-2 。

### 示例

    #include <clocale>
    #include <string>
    #include <iostream>
    #include <cwchar>

    int main()
    {
        // 允许 mbrlen() 以 UTF-8 多字节编码工作
        std::setlocale(LC_ALL, "en_US.utf8");
        // UTF-8 窄多字节编码
        std::string str = u8"水"; // 或 u8"\u6c34" 或 "\xe6\xb0\xb4"
        std::mbstate_t mb = std::mbstate_t();
        int len1 = std::mbrlen(&str[0], 1, &mb);
        if(len1 == -2) {
            std::cout << "The first 1 byte of " << str
                      << " is an incomplete multibyte char (mbrlen returns -2)\n";
        }
        int len2 = std::mbrlen(&str[1], str.size()-1, &mb);
        std::cout << "The remaining " << str.size()-1 << " bytes of " << str
                  << " hold " << len2 << " bytes of the multibyte character\n";
        std::cout << "Attempting to call mbrlen() in the middle of " << str
                  << " while in initial shift state returns "
                  << (int)mbrlen(&str[1], str.size(), &mb) << '\n';

    }

输出：

    The first 1 byte of 水 is an incomplete multibyte char (mbrlen returns -2)
    The remaining 2 bytes of 水 hold 2 bytes of the multibyte character
    Attempting to call mbrlen() in the middle of 水 while in initial shift state returns -1

### 参阅

mbrtowc | 给定状态，转换下个多字节字符为宽字符 (函数)
mblen | 返回下一个多字节字符中的字节数 (函数)
do_length [虚] | 计算转换成给定的 internT 缓冲区会消耗的 externT 字符串长度 (`std::codecvt<InternT,ExternT,State>` 的虚受保护成员函数)