Lines Matching +full:no +full:- +full:ui
5 UI,
13 UI_get_method, UI_set_method, UI_OpenSSL, UI_null - user interface
17 #include <openssl/ui.h>
19 typedef struct ui_st UI;
21 UI *UI_new(void);
22 UI *UI_new_method(const UI_METHOD *method);
23 void UI_free(UI *ui);
25 int UI_add_input_string(UI *ui, const char *prompt, int flags,
27 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
29 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
32 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
35 int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
38 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
41 int UI_add_info_string(UI *ui, const char *text);
42 int UI_dup_info_string(UI *ui, const char *text);
43 int UI_add_error_string(UI *ui, const char *text);
44 int UI_dup_error_string(UI *ui, const char *text);
46 char *UI_construct_prompt(UI *ui_method,
49 void *UI_add_user_data(UI *ui, void *user_data);
50 int UI_dup_user_data(UI *ui, void *user_data);
51 void *UI_get0_user_data(UI *ui);
53 const char *UI_get0_result(UI *ui, int i);
54 int UI_get_result_length(UI *ui, int i);
56 int UI_process(UI *ui);
58 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)());
62 const UI_METHOD *UI_get_method(UI *ui);
63 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
70 UI stands for User Interface, and is general purpose set of routines to
71 prompt the user for text-based information. Through user-written methods
76 All the functions work through a context of the type UI. This context
81 The first thing to do is to create a UI with UI_new() or UI_new_method(),
83 user-defined random data can be passed down to the underlying method
85 UI method doesn't care about these data, but other methods might. Finally,
89 A UI can contain more than one prompt, which are performed in the given
94 UI_process() can be called more than once on the same UI, thereby allowing
95 a UI to have a long lifetime, but can just as well have a short lifetime.
99 UI_new() creates a new UI using the default UI method. When done with
100 this UI, it should be freed using UI_free().
102 UI_new_method() creates a new UI using the given UI method. When done with
103 this UI, it should be freed using UI_free().
105 UI_OpenSSL() returns the built-in UI method (note: not necessarily the
110 UI_null() returns a UI method that does nothing. Its use is to avoid
113 UI_free() removes a UI from memory, along with all other pieces of memory
115 If B<ui> is NULL nothing is done.
117 UI_add_input_string() and UI_add_verify_string() add a prompt to the UI,
126 UI_add_input_boolean() adds a prompt to the UI that's supposed to be answered
128 for no. A set of characters that can be used to cancel the prompt is given
135 The difference between the two is only conceptual. With the built-in method,
136 there's no technical difference between them. Other methods may make a
143 sort will be used (completely depending on the application and the UI
163 time. The built-in UI method doesn't care about this info. Note that several
169 duration, perhaps even the lifetime of the application. The UI object takes
171 the UI is destroyed. UI_dup_user_data() returns 0 on success, or -1 on memory
175 UI with UI_add_user_data() or UI_dup_user_data.
184 and prompting and returns the final status, which is -2 on out-of-band events
185 (Interrupt, Cancel, ...), -1 on error and 0 on success.
189 print the OpenSSL error stack as part of processing the UI, and
190 B<UI_CTRL_IS_REDOABLE>, which returns a flag saying if the used UI can
193 UI_set_default_method() changes the default UI method to the one given.
194 This function is not thread-safe and should not be called at the same time
197 UI_get_default_method() returns a pointer to the current default UI method.
199 UI_get_method() returns the UI method associated with a given UI.
201 UI_set_method() changes the UI method associated with a given UI.
211 the built-in method UI_OpenSSL() will produce UTF-8 encoded strings
216 UI_new() and UI_new_method() return a valid B<UI> structure or NULL if an error
227 UI_dup_user_data() returns 0 on success or -1 on error.
232 returns -1 on error.
236 UI_ctrl() returns a mask on success or -1 on error.
248 Copyright 2001-2020 The OpenSSL Project Authors. All Rights Reserved.