mirrors/node
0
0 Fork 0
mirror of https://github.com/nodejs/node.git synced 2026-10-28 10:15:07 +08:00
Code Activity

doc: improve N-API string-to-native doc

Browse Source 
Mention null termination handling in the string size accounting and
string truncation.

PR-URL: https://github.com/nodejs/node/pull/35322
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michael Dawson <midawson@redhat.com>
This commit is contained in:
Gabriel Schulhof authored and Michael Dawson committed 2020-09-25 17:06:24 -04:00
1 parent 2089b55835
commit b54dd8d91d
1 file changed
+9 -6
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/n-api.md
+9 -6
View File
@@ -3080,9 +3080,10 @@ napi_status napi_get_value_string_latin1(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[in] value`: `napi_value` representing JavaScript string.
* `[in] buf`: Buffer to write the ISO-8859-1-encoded string into. If `NULL` is
passed in, the length of the string (in bytes) is returned.
passed in, the length of the string in bytes and excluding the null terminator
is returned in `result`.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string will be truncated.
insufficient, the returned string will be truncated and null-terminated.
* `[out] result`: Number of bytes copied into the buffer, excluding the null
terminator.
@@ -3109,9 +3110,10 @@ napi_status napi_get_value_string_utf8(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[in] value`: `napi_value` representing JavaScript string.
* `[in] buf`: Buffer to write the UTF8-encoded string into. If `NULL` is passed
in, the length of the string (in bytes) is returned.
in, the length of the string in bytes and excluding the null terminator is
returned in `result`.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string will be truncated.
insufficient, the returned string will be truncated and null-terminated.
* `[out] result`: Number of bytes copied into the buffer, excluding the null
terminator.
@@ -3137,9 +3139,10 @@ napi_status napi_get_value_string_utf16(napi_env env,
* `[in] env`: The environment that the API is invoked under.
* `[in] value`: `napi_value` representing JavaScript string.
* `[in] buf`: Buffer to write the UTF16-LE-encoded string into. If `NULL` is
passed in, the length of the string (in 2-byte code units) is returned.
passed in, the length of the string in 2-byte code units and excluding the
null terminator is returned.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string will be truncated.
insufficient, the returned string will be truncated and null-terminated.
* `[out] result`: Number of 2-byte code units copied into the buffer, excluding
the null terminator.