Current Path :
/
opt
/
cpanel
/
ea-openssl11
/
share
/
man
/
man3
/
Or
Select Your Path :
Upload File :
New :
File
Dir
//opt/cpanel/ea-openssl11/share/man/man3/UI_get_result_minsize.3
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . 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\} .el\{\ . 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. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, 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'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . 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 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . 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 .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "UI_STRING 3" .TH UI_STRING 3 "2023-09-11" "1.1.1w" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "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_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 .SH "SYNOPSIS" .IX 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 .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fB\s-1UI_STRING\s0\fR gets created internally and added to a \fB\s-1UI\s0\fR whenever one of the functions \fIUI_add_input_string()\fR, \fIUI_dup_input_string()\fR, \&\fIUI_add_verify_string()\fR, \fIUI_dup_verify_string()\fR, \&\fIUI_add_input_boolean()\fR, \fIUI_dup_input_boolean()\fR, \fIUI_add_info_string()\fR, \&\fIUI_dup_info_string()\fR, \fIUI_add_error_string()\fR or \fIUI_dup_error_string()\fR is called. For a \fB\s-1UI_METHOD\s0\fR user, there's no need to know more. For a \fB\s-1UI_METHOD\s0\fR creator, it is of interest to fetch text from these \&\fB\s-1UI_STRING\s0\fR objects as well as adding results to some of them. .PP \&\fIUI_get_string_type()\fR is used to retrieve the type of the given \&\fB\s-1UI_STRING\s0\fR. .PP \&\fIUI_get_input_flags()\fR is used to retrieve the flags associated with the given \fB\s-1UI_STRING\s0\fR. .PP \&\fIUI_get0_output_string()\fR is used to retrieve the actual string to output (prompt, info, error, ...). .PP \&\fIUI_get0_action_string()\fR is used to retrieve the action description associated with a \fB\s-1UIT_BOOLEAN\s0\fR type \fB\s-1UI_STRING\s0\fR. For all other \fB\s-1UI_STRING\s0\fR types, \s-1NULL\s0 is returned. See \fIUI_add_input_boolean\fR\|(3). .PP \&\fIUI_get0_result_string()\fR and \fIUI_get_result_string_length()\fR are used to retrieve the result of a prompt and its length. This is only useful for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings. For all other \fB\s-1UI_STRING\s0\fR types, \fIUI_get0_result_string()\fR returns \s-1NULL\s0 and \fIUI_get_result_string_length()\fR returns \-1. .PP \&\fIUI_get0_test_string()\fR is used to retrieve the string to compare the prompt result with. This is only useful for \fB\s-1UIT_VERIFY\s0\fR type strings. For all other \fB\s-1UI_STRING\s0\fR types, \s-1NULL\s0 is returned. .PP \&\fIUI_get_result_minsize()\fR and \fIUI_get_result_maxsize()\fR are used to retrieve the minimum and maximum required size of the result. This is only useful for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings. For all other \fB\s-1UI_STRING\s0\fR types, \-1 is returned. .PP \&\fIUI_set_result_ex()\fR is used to set the result value of a prompt and its length. For \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, this sets the result retrievable with \fIUI_get0_result_string()\fR by copying the contents of \fBresult\fR if its length fits the minimum and maximum size requirements. For \fB\s-1UIT_BOOLEAN\s0\fR type \s-1UI\s0 strings, this sets the first character of the result retrievable with \fIUI_get0_result_string()\fR to the first \&\fBok_char\fR given with \fIUI_add_input_boolean()\fR or \fIUI_dup_input_boolean()\fR if the \fBresult\fR matched any of them, or the first of the \&\fBcancel_chars\fR if the \fBresult\fR matched any of them, otherwise it's set to the \s-1NUL\s0 char \f(CW\*(C`\e0\*(C'\fR. See \fIUI_add_input_boolean\fR\|(3) for more information on \fBok_chars\fR and \&\fBcancel_chars\fR. .PP \&\fIUI_set_result()\fR does the same thing as \fIUI_set_result_ex()\fR, 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. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fIUI_get_string_type()\fR returns the \s-1UI\s0 string type. .PP \&\fIUI_get_input_flags()\fR returns the \s-1UI\s0 string flags. .PP \&\fIUI_get0_output_string()\fR returns the \s-1UI\s0 string output string. .PP \&\fIUI_get0_action_string()\fR returns the \s-1UI\s0 string action description string for \fB\s-1UIT_BOOLEAN\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other type. .PP \&\fIUI_get0_result_string()\fR returns the \s-1UI\s0 string result buffer for \&\fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other type. .PP \&\fIUI_get_result_string_length()\fR returns the \s-1UI\s0 string result buffer's content length for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, \&\-1 for any other type. .PP \&\fIUI_get0_test_string()\fR returns the \s-1UI\s0 string action description string for \fB\s-1UIT_VERIFY\s0\fR type \s-1UI\s0 strings, \s-1NULL\s0 for any other type. .PP \&\fIUI_get_result_minsize()\fR returns the minimum allowed result size for the \s-1UI\s0 string for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings, \&\-1 for any other type. .PP \&\fIUI_get_result_maxsize()\fR returns the minimum allowed result size for the \s-1UI\s0 string for \fB\s-1UIT_PROMPT\s0\fR and \fB\s-1UIT_VERIFY\s0\fR type strings, \&\-1 for any other type. .PP \&\fIUI_set_result()\fR returns 0 on success or when the \s-1UI\s0 string is of any type other than \fB\s-1UIT_PROMPT\s0\fR, \fB\s-1UIT_VERIFY\s0\fR or \fB\s-1UIT_BOOLEAN\s0\fR, \-1 on error. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1\fIUI\s0\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the OpenSSL license (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>.
