apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jfcl...@apache.org
Subject cvs commit: apr-iconv/include apr_iconv.h
Date Fri, 01 Oct 2004 15:20:18 GMT
jfclere     2004/10/01 08:20:18

  Modified:    include  apr_iconv.h
  Log:
  And a small description of the 3 routines given by apr-iconv API.
  
  Revision  Changes    Path
  1.5       +27 -3     apr-iconv/include/apr_iconv.h
  
  Index: apr_iconv.h
  ===================================================================
  RCS file: /home/cvs/apr-iconv/include/apr_iconv.h,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- apr_iconv.h	23 Jan 2003 01:04:09 -0000	1.4
  +++ apr_iconv.h	1 Oct 2004 15:20:18 -0000	1.5
  @@ -95,9 +95,33 @@
   
   /* __BEGIN_DECLS */
   
  -API_DECLARE(apr_status_t) apr_iconv_open(const char *, const char *, apr_pool_t *, apr_iconv_t
*);
  -API_DECLARE(apr_status_t) apr_iconv(apr_iconv_t, const char **, apr_size_t *, char **,
apr_size_t *, apr_size_t *);
  -API_DECLARE(apr_status_t) apr_iconv_close(apr_iconv_t, apr_pool_t *);
  +/**
  + * Create a conversion descriptor.
  + * @param to name of charset to convert to.
  + * @param from name of charset of the input bytes.
  + * @param pool pool to alloc memory.
  + * @param cd conversion descriptor created in pool.
  +API_DECLARE(apr_status_t) apr_iconv_open(const char *to, const char *from,
  +                                         apr_pool_t *pool, apr_iconv_t *cd);
  +/**
  + * Perform character set conversion.
  + * @param cd conversion descriptor created by apr_iconv_open().
  + * @param inbuf input buffer.
  + * @param inbytesleft bytes to convert.
  + * @param outbuf output buffer.
  + * @param outbytesleft space (in bytes) available in outbuf.
  + * @param translated number of input bytes converted.
  + */
  +API_DECLARE(apr_status_t) apr_iconv(apr_iconv_t cd,
  +                          const char **inbuf, apr_size_t *inbytesleft,
  +                          char **outbuf, apr_size_t *outbytesleft,
  +                          apr_size_t *translated);
  +/**
  + * Deallocate descriptor for character set conversion.
  + * @param cd conversion descriptor.
  + * @param pool pool used in the apr_iconv_open().
  + */
  +API_DECLARE(apr_status_t) apr_iconv_close(apr_iconv_t cd, apr_pool_t *pool);
   
   /* __END_DECLS */
   
  
  
  

Mime
View raw message