napi_get_value_string_utf16


napi_status napi_get_value_string_utf16(napi_env env,
                                        napi_value value,
                                        char16_t* buf,
                                        size_t bufsize,
                                        size_t* result) 
  • [in] env:调用该 API 时所处的环境。
  • [in] value:表示 JavaScript 字符串的 napi_value
  • [in] buf:用于写入 UTF16-LE 编码字符串的缓冲区。如果传入 NULL,将返回字符串的长度(以 2 字节代码单元计算,不包括空终止符)。
  • [in] bufsize:目标缓冲区的大小。当该值不足时,返回的字符串将被截断并以空字符结尾。如果该值为零,则不会返回字符串,缓冲区也不会发生任何更改。
  • [out] result:复制到缓冲区的 2 字节代码单元数量,不包括空终止符。

如果 API 成功,则返回 napi_ok。如果传入了非 string 类型的 napi_value,则返回 napi_string_expected

【Returns napi_ok if the API succeeded. If a non-string napi_value is passed in it returns napi_string_expected.】

此 API 返回对应于传入值的 UTF16 编码字符串。

【This API returns the UTF16-encoded string corresponding the value passed in.】