Browse Source

doc: fix doc for napi_get_value_string_utf8

The API for napi_get_value_string_utf8() appears to have been
previously changed. This improves the doc reflect the current design.

PR-URL: https://github.com/nodejs/node/pull/14529
Fixes: https://github.com/nodejs/node/issues/14398
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
canary-base
Daniel Taveras 8 years ago
committed by Michael Dawson
parent
commit
82bad0b4d8
  1. 26
      doc/api/n-api.md

26
doc/api/n-api.md

@ -1811,10 +1811,10 @@ NAPI_EXTERN napi_status napi_get_value_string_latin1(napi_env env,
- `[in] value`: `napi_value` representing JavaScript string. - `[in] value`: `napi_value` representing JavaScript string.
- `[in] buf`: Buffer to write the ISO-8859-1-encoded string into. If NULL is - `[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) is returned.
- `[in] bufsize`: Size of the destination buffer. - `[in] bufsize`: Size of the destination buffer. When this value is
- `[out] result`: Number of bytes copied into the buffer including the null insufficient, the returned string will be truncated.
terminator. If the buffer size is insufficient, the string will be truncated - `[out] result`: Number of bytes copied into the buffer, excluding the null
including a null terminator. terminator.
Returns `napi_ok` if the API succeeded. If a non-String `napi_value` Returns `napi_ok` if the API succeeded. If a non-String `napi_value`
is passed in it returns `napi_string_expected`. is passed in it returns `napi_string_expected`.
@ -1837,11 +1837,11 @@ napi_status napi_get_value_string_utf8(napi_env env,
- `[in] env`: The environment that the API is invoked under. - `[in] env`: The environment that the API is invoked under.
- `[in] value`: `napi_value` representing JavaScript string. - `[in] value`: `napi_value` representing JavaScript string.
- `[in] buf`: Buffer to write the UTF8-encoded string into. If NULL is passed - `[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) is returned.
- `[in] bufsize`: Size of the destination buffer. - `[in] bufsize`: Size of the destination buffer. When this value is
- `[out] result`: Number of bytes copied into the buffer including the null insufficient, the returned string will be truncated.
terminator. If the buffer size is insufficient, the string will be truncated - `[out] result`: Number of bytes copied into the buffer, excluding the null
including a null terminator. terminator.
Returns `napi_ok` if the API succeeded. If a non-String `napi_value` Returns `napi_ok` if the API succeeded. If a non-String `napi_value`
is passed in it returns `napi_string_expected`. is passed in it returns `napi_string_expected`.
@ -1864,10 +1864,10 @@ napi_status napi_get_value_string_utf16(napi_env env,
- `[in] value`: `napi_value` representing JavaScript string. - `[in] value`: `napi_value` representing JavaScript string.
- `[in] buf`: Buffer to write the UTF16-LE-encoded string into. If NULL is - `[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) is returned.
- `[in] bufsize`: Size of the destination buffer. - `[in] bufsize`: Size of the destination buffer. When this value is
- `[out] result`: Number of 2-byte code units copied into the buffer including insufficient, the returned string will be truncated.
the null terminator. If the buffer size is insufficient, the string will be - `[out] result`: Number of 2-byte code units copied into the buffer, excluding the null
truncated including a null terminator. terminator.
Returns `napi_ok` if the API succeeded. If a non-String `napi_value` Returns `napi_ok` if the API succeeded. If a non-String `napi_value`
is passed in it returns `napi_string_expected`. is passed in it returns `napi_string_expected`.

Loading…
Cancel
Save