node_api_create_external_string_latin1


稳定性: 1 - 实验性

napi_status
node_api_create_external_string_latin1(napi_env env,
                                       char* str,
                                       size_t length,
                                       napi_finalize finalize_callback,
                                       void* finalize_hint,
                                       napi_value* result,
                                       bool* copied); 
  • [in] env:API 被调用时所处的环境。
  • [in] str:表示 ISO-8859-1 编码字符串的字符缓冲区。
  • [in] length:字符串的字节长度,如果是以空字符结尾,则为 NAPI_AUTO_LENGTH
  • [in] finalize_callback:当字符串被收集时要调用的函数。该函数将使用以下参数调用:
    • [in] env:附加组件运行的环境。如果字符串是在终止工作线程或主 Node.js 实例的过程中收集的,则该值可能为 null。
    • [in] data:这是作为 void* 指针的值 str
    • [in] finalize_hint:这是传递给 API 的值 finalize_hintnapi_finalize 提供了更多详细信息。此参数是可选的。传递空值意味着在对应的 JavaScript 字符串被回收时,附加组件不需要收到通知。
  • [in] finalize_hint:在收集过程中传递给最终回调的可选提示。
  • [out] result:一个表示 JavaScript stringnapi_value
  • [out] copied:字符串是否被复制。如果是,终结器已经被调用来销毁 str

如果 API 成功,则返回 napi_ok

🌐 Returns napi_ok if the API succeeded.

该 API 从 ISO-8859-1 编码的 C 字符串创建一个 JavaScript string 值。原生字符串可能不会被复制,因此必须在 JavaScript 值的整个生命周期内存在。

🌐 This API creates a JavaScript string value from an ISO-8859-1-encoded C string. The native string may not be copied and must thus exist for the entire life cycle of the JavaScript value.

JavaScript 的 string 类型在 ECMAScript 语言规范的 第6.1.4节 中有描述。

🌐 The JavaScript string type is described in Section 6.1.4 of the ECMAScript Language Specification.