diff options
| author | Richard Levitte <levitte@openssl.org> | 2017-03-11 00:51:53 +0100 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2017-03-11 00:51:53 +0100 |
| commit | 5469600e367a1a4cf3dd929159b5bc8091db49de (patch) | |
| tree | c65df4ee9493b119003d7b6b2f8b042c0636cad2 /doc/man3/UI_new.pod | |
| parent | d61461a7525322d188f9c6e3f90cfc93916cc636 (diff) | |
| download | openssl-5469600e367a1a4cf3dd929159b5bc8091db49de.tar.gz | |
Document UI_METHOD and UI_STRING, both useful for UI_METHOD creators
Reviewed-by: Tim Hudson <tjh@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2903)
Diffstat (limited to 'doc/man3/UI_new.pod')
| -rw-r--r-- | doc/man3/UI_new.pod | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/man3/UI_new.pod b/doc/man3/UI_new.pod index 08400d3492..8d4ae659a6 100644 --- a/doc/man3/UI_new.pod +++ b/doc/man3/UI_new.pod @@ -2,7 +2,7 @@ =head1 NAME -UI, UI_METHOD, +UI, UI_new, UI_new_method, UI_free, 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, @@ -16,7 +16,6 @@ UI_set_method, UI_OpenSSL, UI_null - user interface #include <openssl/ui.h> typedef struct ui_st UI; - typedef struct ui_method_st UI_METHOD; UI *UI_new(void); UI *UI_new_method(const UI_METHOD *method); @@ -65,7 +64,7 @@ UI_set_method, UI_OpenSSL, UI_null - user interface UI stands for User Interface, and is general purpose set of routines to prompt the user for text-based information. Through user-written methods -(see L<ui_create(3)>), prompting can be done in any way +(see L<UI_create_method(3)>), prompting can be done in any way imaginable, be it plain text prompting, through dialog boxes or from a cell phone. @@ -159,7 +158,8 @@ UI_get0_result() returns a pointer to the result buffer associated with the information indexed by I<i>. UI_process() goes through the information given so far, does all the printing -and prompting and returns. +and prompting and returns the final status, which is -2 on out-of-band events +(Interrupt, Cancel, ...), -1 on error and 0 on success. UI_ctrl() adds extra control for the application author. For now, it understands two commands: B<UI_CTRL_PRINT_ERRORS>, which makes UI_process() |