Commit 7d00fc2
doc: clarify napi_get_value_string_* for bufsize 0
PR-URL: #58158
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>1 parent aabafbc commit 7d00fc2
1 file changed
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3683,6 +3683,8 @@ napi_status napi_get_value_string_latin1(napi_env env, | |||
| 3683 | 3683 | is returned in `result`. | |
| 3684 | 3684 | * `[in] bufsize`: Size of the destination buffer. When this value is | |
| 3685 | 3685 | insufficient, the returned string is truncated and null-terminated. | |
| 3686 | + If this value is zero, then the string is not returned and no changes are done | ||
| 3687 | + to the buffer. | ||
| 3686 | 3688 | * `[out] result`: Number of bytes copied into the buffer, excluding the null | |
| 3687 | 3689 | terminator. | |
| 3688 | 3690 | ||
@@ -3714,6 +3716,8 @@ napi_status napi_get_value_string_utf8(napi_env env, | |||
| 3714 | 3716 | returned in `result`. | |
| 3715 | 3717 | * `[in] bufsize`: Size of the destination buffer. When this value is | |
| 3716 | 3718 | insufficient, the returned string is truncated and null-terminated. | |
| 3719 | + If this value is zero, then the string is not returned and no changes are done | ||
| 3720 | + to the buffer. | ||
| 3717 | 3721 | * `[out] result`: Number of bytes copied into the buffer, excluding the null | |
| 3718 | 3722 | terminator. | |
| 3719 | 3723 | ||
@@ -3744,6 +3748,8 @@ napi_status napi_get_value_string_utf16(napi_env env, | |||
| 3744 | 3748 | null terminator is returned. | |
| 3745 | 3749 | * `[in] bufsize`: Size of the destination buffer. When this value is | |
| 3746 | 3750 | insufficient, the returned string is truncated and null-terminated. | |
| 3751 | + If this value is zero, then the string is not returned and no changes are done | ||
| 3752 | + to the buffer. | ||
| 3747 | 3753 | * `[out] result`: Number of 2-byte code units copied into the buffer, excluding | |
| 3748 | 3754 | the null terminator. | |
| 3749 | 3755 | ||
0 commit comments