Skip to content

doc: clarify napi_get_value_string_* for bufsize 0 #58158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2025
Merged

doc: clarify napi_get_value_string_* for bufsize 0 #58158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e0f77b
doc: clarify napi_get_value_string_* for bufsize 0
tniessen May 4, 2025
32bc0ad
Apply suggestions from code review
tniessen May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3689,6 +3689,8 @@ napi_status napi_get_value_string_latin1(napi_env env,
is returned in `result`.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string is truncated and null-terminated.
If this value is zero, then the string is not returned and no changes are done
to the buffer.
* `[out] result`: Number of bytes copied into the buffer, excluding the null
terminator.

Expand Down Expand Up @@ -3720,6 +3722,8 @@ napi_status napi_get_value_string_utf8(napi_env env,
returned in `result`.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string is truncated and null-terminated.
If this value is zero, then the string is not returned and no changes are done
to the buffer.
* `[out] result`: Number of bytes copied into the buffer, excluding the null
terminator.

Expand Down Expand Up @@ -3750,6 +3754,8 @@ napi_status napi_get_value_string_utf16(napi_env env,
null terminator is returned.
* `[in] bufsize`: Size of the destination buffer. When this value is
insufficient, the returned string is truncated and null-terminated.
If this value is zero, then the string is not returned and no changes are done
to the buffer.
* `[out] result`: Number of 2-byte code units copied into the buffer, excluding
the null terminator.

Expand Down
Loading