0 ;ˆl–Ðz¾”ªe¶…8 ^¸ÜdJbÑ¿È „ Í„_Ça–ß=¿JJj"Tâ€~ã/\ ÊbÑ¿Æ?÷/* * WARNING: do not edit! * Generated by Makefile from include/openssl/ui.h.in * * Copyright 2001-2020 The OpenSSL Project Authors. All Rights Reserved. * * Licensed under the Apache License 2.0 (the "License"). You may not use * this file except in compliance with the License. You can obtain a copy * in the file LICENSE in the source distribution or at * https://www.openssl.org/source/license.html */ /* clang-format off */ /* clang-format on */ #ifndef OPENSSL_UI_H #define OPENSSL_UI_H #pragma once #include #ifndef OPENSSL_NO_DEPRECATED_3_0 #define HEADER_UI_H #endif #include #ifndef OPENSSL_NO_DEPRECATED_1_1_0 #include #endif #include #include #include #include /* For compatibility reasons, the macro OPENSSL_NO_UI is currently retained */ #ifndef OPENSSL_NO_DEPRECATED_3_0 #ifdef OPENSSL_NO_UI_CONSOLE #define OPENSSL_NO_UI #endif #endif #ifdef __cplusplus extern "C" { #endif /* * All the following functions return -1 or NULL on error and in some cases * (UI_process()) -2 if interrupted or in some other way cancelled. When * everything is fine, they return 0, a positive value or a non-NULL pointer, * all depending on their purpose. */ /* Creators and destructor. */ UI *UI_new(void); UI *UI_new_method(const UI_METHOD *method); void UI_free(UI *ui); /*- The following functions are used to add strings to be printed and prompt strings to prompt for data. The names are UI_{add,dup}__string and UI_{add,dup}_input_boolean. UI_{add,dup}__string have the following meanings: add add a text or prompt string. The pointers given to these functions are used verbatim, no copying is done. dup make a copy of the text or prompt string, then add the copy to the collection of strings in the user interface. The function is a name for the functionality that the given string shall be used for. It can be one of: input use the string as data prompt. verify use the string as verification prompt. This is used to verify a previous input. info use the string for informational output. error use the string for error output. Honestly, there's currently no difference between info and error for the moment. UI_{add,dup}_input_boolean have the same semantics for "add" and "dup", and are typically used when one wants to prompt for a yes/no response. All of the functions in this group take a UI and a prompt string. The string input and verify addition functions also take a flag argument, a buffer for the result to end up with, a minimum input size and a maximum input size (the result buffer MUST be large enough to be able to contain the maximum number of characters). Additionally, the verify addition functions takes another buffer to compare the result against. The boolean input functions take an action description string (which should be safe to ignore if the expected user action is obvious, for example with a dialog box with an OK button and a Cancel button), a string of acceptable characters to mean OK and to mean Cancel. The two last strings are checked to make sure they don't have common characters. Additionally, the same flag argument as for the string input is taken, as well as a result buffer. The result buffer is required to be at least one byte long. Depending on the answer, the first character from the OK or the Cancel character strings will be stored in the first byte of the result buffer. No NUL will be added, so the result is *not* a string. On success, the all return an index of the added information. That index is useful when retrieving results with UI_