Commit 727ee8cf authored by Richard Levitte's avatar Richard Levitte
Browse files

Documentation: Clarify sizes for UI_add_input_string() 



The given sizes to not include the final NUL character.

RT#2622

Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
parent 6ae54524

doc/crypto/ui.pod

+6 −6
Original line number Diff line number Diff line
@@ -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