iconv/iconv.h

   1 /* Copyright (C) 1997, 1998, 1999, 2000, 2003 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with the GNU C Library; if not, write to the Free
  16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  17    02111-1307 USA.  */
  18
  19 #ifndef _ICONV_H
  20 #define _ICONV_H        1
  21
  22 #include <features.h>
  23 #define __need_size_t
  24 #include <stddef.h>
  25
  26
  27 __BEGIN_DECLS
  28
  29 /* Identifier for conversion method from one codeset to another.  */
  30 typedef void *iconv_t;
  31
  32
  33 /* Allocate descriptor for code conversion from codeset FROMCODE to
  34    codeset TOCODE.
  35
  36    This function is a possible cancellation points and therefore not
  37    marked with __THROW.  */
  38 extern iconv_t iconv_open (__const char *__tocode, __const char *__fromcode);
  39
  40 /* Convert at most *INBYTESLEFT bytes from *INBUF according to the
  41    code conversion algorithm specified by CD and place up to
  42    *OUTBYTESLEFT bytes in buffer at *OUTBUF.  */
  43 extern size_t iconv (iconv_t __cd, char **__restrict __inbuf,
  44                      size_t *__restrict __inbytesleft,
  45                      char **__restrict __outbuf,
  46                      size_t *__restrict __outbytesleft);
  47
  48 /* Free resources allocated for descriptor CD for code conversion.
  49
  50    This function is a possible cancellation points and therefore not
  51    marked with __THROW.  */
  52 extern int iconv_close (iconv_t __cd);
  53
  54 __END_DECLS
  55
  56 #endif /* iconv.h */