contrib/idn/idnkit-1.0-src/include/idn/result.h

   1 /* $Id: result.h,v 1.1.1.1 2003/06/04 00:25:42 marka Exp $ */
   2 /*
   3  * Copyright (c) 2000 Japan Network Information Center.  All rights reserved.
   4  *
   5  * By using this file, you agree to the terms and conditions set forth bellow.
   6  *
   7  *                      LICENSE TERMS AND CONDITIONS
   8  *
   9  * The following License Terms and Conditions apply, unless a different
  10  * license is obtained from Japan Network Information Center ("JPNIC"),
  11  * a Japanese association, Kokusai-Kougyou-Kanda Bldg 6F, 2-3-4 Uchi-Kanda,
  12  * Chiyoda-ku, Tokyo 101-0047, Japan.
  13  *
  14  * 1. Use, Modification and Redistribution (including distribution of any
  15  *    modified or derived work) in source and/or binary forms is permitted
  16  *    under this License Terms and Conditions.
  17  *
  18  * 2. Redistribution of source code must retain the copyright notices as they
  19  *    appear in each source code file, this License Terms and Conditions.
  20  *
  21  * 3. Redistribution in binary form must reproduce the Copyright Notice,
  22  *    this License Terms and Conditions, in the documentation and/or other
  23  *    materials provided with the distribution.  For the purposes of binary
  24  *    distribution the "Copyright Notice" refers to the following language:
  25  *    "Copyright (c) 2000-2002 Japan Network Information Center.  All rights reserved."
  26  *
  27  * 4. The name of JPNIC may not be used to endorse or promote products
  28  *    derived from this Software without specific prior written approval of
  29  *    JPNIC.
  30  *
  31  * 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC
  32  *    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  *    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  34  *    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL JPNIC BE LIABLE
  35  *    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  36  *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  37  *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  38  *    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  39  *    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  40  *    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  41  *    ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #ifndef IDN_RESULT_H
  45 #define IDN_RESULT_H 1
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 #include <idn/export.h>
  52
  53 /*
  54  * libidnkit result code.
  55  */
  56 typedef enum {
  57         idn_success,
  58         idn_notfound,
  59         idn_invalid_encoding,
  60         idn_invalid_syntax,
  61         idn_invalid_name,
  62         idn_invalid_message,
  63         idn_invalid_action,
  64         idn_invalid_codepoint,
  65         idn_invalid_length,
  66         idn_buffer_overflow,
  67         idn_noentry,
  68         idn_nomemory,
  69         idn_nofile,
  70         idn_nomapping,
  71         idn_context_required,
  72         idn_prohibited,
  73         idn_failure     /* !!This must be the last one!! */
  74 } idn_result_t;
  75
  76 /*
  77  * Get the string description of a result code.
  78  */
  79 IDN_EXPORT char *
  80 idn_result_tostring(idn_result_t result);
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif /* IDN_RESULT_H */