UI_get_string_type (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

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

(The comments found at the beginning of the groff file "man3/UI_get_string_type.3ssl".)

NAME

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_get0_test_string, UI_get_result_minsize, UI_get_result_maxsize, UI_set_result - User interface string parsing

SYNOPSIS

 #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);
 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);

DESCRIPTION

The gets created internally and added to a whenever one of the functions UI_add_input_string(), UI_dup_input_string(), UI_add_verify_string(), UI_dup_verify_string(), UI_add_input_boolean(), UI_dup_input_boolean(), UI_add_info_string(), UI_dup_info_string(), UI_add_error_string() or UI_dup_error_string() is called. For a user, there's no need to know more. For a creator, it is of interest to fetch text from these objects as well as adding results to some of them.

UI_get_string_type() is used to retrieve the type of the given

.

UI_get_input_flags() is used to retrieve the flags associated with the given

.

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

UI_get0_action_string() is used to retrieve the action description associated with a

type . For all other types, is returned. See UI_add_input_boolean(3).

UI_get0_result_string() is used to retrieve the result of a prompt. This is only useful for

and type strings. For all other types, is returned.

UI_get0_test_string() is used to retrieve the string to compare the prompt result with. This is only useful for

type strings. For all other types, is returned.

UI_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

and type strings. For all other types, -1 is returned.

UI_set_result() is used to set the result value of a prompt. For

and type 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 type strings, this sets the first character of the result retrievable with UI_get0_result_string() to the first ok_char given with UI_add_input_boolean() or UI_dup_input_boolean() if the result matched any of them, or the first of the cancel_chars if the result matched any of them, otherwise it's set to the char "\0". See UI_add_input_boolean(3) for more information on ok_chars and cancel_chars.

RETURN VALUES

UI_get_string_type() returns the string type.

UI_get_input_flags() returns the

string flags.

UI_get0_output_string() returns the

string output string.

UI_get0_action_string() returns the

string action description string for type strings, for any other type.

UI_get0_result_string() returns the

string result buffer for and type strings, for any other type.

UI_get0_test_string() returns the

string action description string for type strings, for any other type.

UI_get_result_minsize() returns the minimum allowed result size for the

string for for and type strings, -1 for any other type.

UI_get_result_maxsize() returns the minimum allowed result size for the

string for for and type strings, -1 for any other type.

UI_set_result() returns 0 on success or when the

string is of any type other than , or , -1 on error.

SEE ALSO

(3)

COPYRIGHT

Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the ``License''). You may not use this file except in compliance with the License. You can obtain a copy in the file

in the source distribution or at <www.openssl.org/source/license.html>.