Skip to content

doc: fix return results description of napi_get_value_string_utf8 #14529

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

Closed
taveras wants to merge 5 commits into from
+13 −13
Closed

doc: fix return results description of napi_get_value_string_utf8 #14529

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
08d72e1
doc: fix return results description of napi_get_value_string_utf8
Jul 28, 2017
1392292
doc: add note regarding insufficient buffer size
taveras Aug 12, 2017
a337a5b
doc: fix line to wrap at 80 chars
taveras Aug 16, 2017
5b032a1
doc: remove unnecessary character
taveras Aug 18, 2017
c607acb
doc: fix results descriptions of napi_get_value_string_*
taveras Aug 18, 2017
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
Prev Previous commit
Next Next commit
doc: add note regarding insufficient buffer size
  • Loading branch information
@taveras
taveras committed Aug 18, 2017
commit 139229255e07e3cedac53dae5d209abf23b50d89
4 changes: 2 additions & 2 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1837,8 +1837,8 @@ 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] bufsize`: Size of the destination buffer.
in, the length of the string (in bytes) is returned.
- `[in] bufsize`: Size of the destination buffer. When this value is insufficient, the returned string will be truncated.
- `[out] result`: Number of bytes copied into the buffer, excluding the null
terminator.
Copy link
Copy Markdown
Contributor

@kfarnung kfarnung Jul 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the buffer size is insufficient, the string will be truncated including a null terminator.

I feel like this information should be represented somewhere, maybe as part of the bufsize parameter?

Copy link
Copy Markdown
Author

@taveras taveras Jul 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, yes! do you feel it may be best to keep this sentence within the [out] result description?

Copy link
Copy Markdown
Contributor

@kfarnung kfarnung Jul 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be better to move that sentence to be part of the [in] bufsize parameter comment. That's where it's relevant to call out that the string will be truncated, but still include a null terminator.


Expand Down