diff options
| author | Richard Levitte <levitte@openssl.org> | 2016-05-16 15:39:50 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2016-05-16 18:34:45 +0200 |
| commit | 727ee8cfeb2893d5aec4a6e571e9adf0667e9135 (patch) | |
| tree | 2dfe7218928ca5ef4f2bdaa8301069161ea942fb | |
| parent | 6ae545248109710365189047ba945700ab8afff3 (diff) | |
Documentation: Clarify sizes for UI_add_input_string()
The given sizes to not include the final NUL character.
RT#2622
Reviewed-by: Matt Caswell <matt@openssl.org>
| -rw-r--r-- | doc/crypto/ui.pod | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/crypto/ui.pod b/doc/crypto/ui.pod index f03e989561..bd4e396ab9 100644 --- a/doc/crypto/ui.pod +++ b/doc/crypto/ui.pod @@ -110,12 +110,12 @@ If B<ui> is NULL nothing is done. UI_add_input_string() and UI_add_verify_string() add a prompt to the UI, as well as flags and a result buffer and the desired minimum and maximum -sizes of the result. The given information is used to prompt for -information, for example a password, and to verify a password (i.e. having -the user enter it twice and check that the same string was entered twice). -UI_add_verify_string() takes and extra argument that should be a pointer -to the result buffer of the input string that it's supposed to verify, or -verification will fail. +sizes of the result, not counting the final NUL character. The given +information is used to prompt for information, for example a password, +and to verify a password (i.e. having the user enter it twice and check +that the same string was entered twice). UI_add_verify_string() takes +and extra argument that should be a pointer to the result buffer of the +input string that it's supposed to verify, or verification will fail. UI_add_input_boolean() adds a prompt to the UI that's supposed to be answered in a boolean way, with a single character for yes and a different character |