Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "UI_STRING 3ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
UI_STRING, UI_string_types, UI_get_string_type, UI_get_input_flags, UI_get0_output_string, UI_get0_action_string, UI_get0_result_string, UI_get_result_string_length, UI_get0_test_string, UI_get_result_minsize, UI_get_result_maxsize, UI_set_result, UI_set_result_ex \- User interface string parsing Header "SYNOPSIS" .Vb 1 #include <openssl/ui.h> \& typedef struct ui_string_st UI_STRING; \& enum UI_string_types { UIT_NONE = 0, UIT_PROMPT, /* Prompt for a string */ UIT_VERIFY, /* Prompt for a string and verify */ UIT_BOOLEAN, /* Prompt for a yes/no response */ UIT_INFO, /* Send info to the user */ UIT_ERROR /* Send an error message to the user */ }; \& enum UI_string_types UI_get_string_type(UI_STRING *uis); int UI_get_input_flags(UI_STRING *uis); const char *UI_get0_output_string(UI_STRING *uis); const char *UI_get0_action_string(UI_STRING *uis); const char *UI_get0_result_string(UI_STRING *uis); int UI_get_result_string_length(UI_STRING *uis); const char *UI_get0_test_string(UI_STRING *uis); int UI_get_result_minsize(UI_STRING *uis); int UI_get_result_maxsize(UI_STRING *uis); int UI_set_result(UI *ui, UI_STRING *uis, const char *result); int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len); .Ve Header "DESCRIPTION" The \s-1UI_STRING\s0 gets created internally and added to a \s-1UI\s0 whenever one of the functions UI_add_input_string(), UI_dup_input_string(), \fBUI_add_verify_string(), UI_dup_verify_string(), \fBUI_add_input_boolean(), UI_dup_input_boolean(), UI_add_info_string(), \fBUI_dup_info_string(), UI_add_error_string() or UI_dup_error_string() is called. For a \s-1UI_METHOD\s0 user, there's no need to know more. For a \s-1UI_METHOD\s0 creator, it is of interest to fetch text from these \fB\s-1UI_STRING\s0 objects as well as adding results to some of them.

\fBUI_get_string_type() is used to retrieve the type of the given \fB\s-1UI_STRING\s0.

\fBUI_get_input_flags() is used to retrieve the flags associated with the given \s-1UI_STRING\s0.

\fBUI_get0_output_string() is used to retrieve the actual string to output (prompt, info, error, ...).

\fBUI_get0_action_string() is used to retrieve the action description associated with a \s-1UIT_BOOLEAN\s0 type \s-1UI_STRING\s0. For all other \s-1UI_STRING\s0 types, \s-1NULL\s0 is returned. See UI_add_input_boolean\|(3).

\fBUI_get0_result_string() and UI_get_result_string_length() are used to retrieve the result of a prompt and its length. This is only useful for \s-1UIT_PROMPT\s0 and \s-1UIT_VERIFY\s0 type strings. For all other \s-1UI_STRING\s0 types, UI_get0_result_string() returns \s-1NULL\s0 and UI_get_result_string_length() returns -1.

\fBUI_get0_test_string() is used to retrieve the string to compare the prompt result with. This is only useful for \s-1UIT_VERIFY\s0 type strings. For all other \s-1UI_STRING\s0 types, \s-1NULL\s0 is returned.

\fBUI_get_result_minsize() and UI_get_result_maxsize() are used to retrieve the minimum and maximum required size of the result. This is only useful for \s-1UIT_PROMPT\s0 and \s-1UIT_VERIFY\s0 type strings. For all other \s-1UI_STRING\s0 types, -1 is returned.

\fBUI_set_result_ex() is used to set the result value of a prompt and its length. For \s-1UIT_PROMPT\s0 and \s-1UIT_VERIFY\s0 type \s-1UI\s0 strings, this sets the result retrievable with UI_get0_result_string() by copying the contents of result if its length fits the minimum and maximum size requirements. For \s-1UIT_BOOLEAN\s0 type \s-1UI\s0 strings, this sets the first character of the result retrievable with UI_get0_result_string() to the first \fBok_char given with UI_add_input_boolean() or UI_dup_input_boolean() if the result matched any of them, or the first of the \fBcancel_chars if the result matched any of them, otherwise it's set to the \s-1NUL\s0 char \*(C`\e0\*(C'. See UI_add_input_boolean\|(3) for more information on ok_chars and \fBcancel_chars.

\fBUI_set_result() does the same thing as UI_set_result_ex(), but calculates its length internally. It expects the string to be terminated with a \s-1NUL\s0 byte, and is therefore only useful with normal C strings.

Header "RETURN VALUES" \fBUI_get_string_type() returns the \s-1UI\s0 string type.

\fBUI_get_input_flags() returns the \s-1UI\s0 string flags.

\fBUI_get0_output_string() returns the \s-1UI\s0 string output string.

\fBUI_get0_action_string() returns the \s-1UI\s0 string action description string for \s-1UIT_BOOLEAN\s0 type \s-1UI\s0 strings, \s-1NULL\s0 for any other type.

\fBUI_get0_result_string() returns the \s-1UI\s0 string result buffer for \fB\s-1UIT_PROMPT\s0 and \s-1UIT_VERIFY\s0 type \s-1UI\s0 strings, \s-1NULL\s0 for any other type.

\fBUI_get_result_string_length() returns the \s-1UI\s0 string result buffer's content length for \s-1UIT_PROMPT\s0 and \s-1UIT_VERIFY\s0 type \s-1UI\s0 strings, \-1 for any other type.

\fBUI_get0_test_string() returns the \s-1UI\s0 string action description string for \s-1UIT_VERIFY\s0 type \s-1UI\s0 strings, \s-1NULL\s0 for any other type.

\fBUI_get_result_minsize() returns the minimum allowed result size for the \s-1UI\s0 string for \s-1UIT_PROMPT\s0 and \s-1UIT_VERIFY\s0 type strings, \-1 for any other type.

\fBUI_get_result_maxsize() returns the minimum allowed result size for the \s-1UI\s0 string for \s-1UIT_PROMPT\s0 and \s-1UIT_VERIFY\s0 type strings, \-1 for any other type.

\fBUI_set_result() returns 0 on success or when the \s-1UI\s0 string is of any type other than \s-1UIT_PROMPT\s0, \s-1UIT_VERIFY\s0 or \s-1UIT_BOOLEAN\s0, -1 on error.

Header "SEE ALSO" \s-1UI\s0\|(3) Header "COPYRIGHT" Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.