substitute iconv implementation


Defines

#define API_DECLARE(type)   type
#define API_DECLARE_NONSTD(type)   type
#define API_DECLARE_DATA

Typedefs

typedef void * apr_iconv_t

Functions

apr_status_t apr_iconv_open (const char *to, const char *from, apr_pool_t *pool, apr_iconv_t *cd)
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)
apr_status_t apr_iconv_close (apr_iconv_t cd, apr_pool_t *pool)

Detailed Description


Define Documentation

#define API_DECLARE ( type   )     type

The public apr-iconv functions are declared with API_DECLARE(), so they use the most portable calling convention. Public apr-iconv functions with variable arguments must use API_DECLARE_NONSTD().

API_DECLARE(rettype) apr_func(args);

#define API_DECLARE_DATA

All exported apr-iconv variables are declared with API_DECLARE_DATA This assures the appropriate indirection is invoked at compile time.

API_DECLARE_DATA type apr_variable; extern API_DECLARE_DATA type apr_variable; syntax is required for declarations within headers to properly import the variable.

#define API_DECLARE_NONSTD ( type   )     type

The private apr-iconv functions are declared with API_DECLARE_NONSTD(), so they use the most optimal C language calling conventions.

API_DECLARE(rettype) apr_func(args);


Function Documentation

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 
)

Perform character set conversion.

Parameters:
cd conversion descriptor created by apr_iconv_open().
inbuf input buffer.
inbytesleft bytes to convert.
outbuf output buffer.
outbytesleft space (in bytes) available in outbuf.
translated number of input bytes converted.

apr_status_t apr_iconv_close ( apr_iconv_t  cd,
apr_pool_t *  pool 
)

Deallocate descriptor for character set conversion.

Parameters:
cd conversion descriptor.
pool pool used in the apr_iconv_open().

apr_status_t apr_iconv_open ( const char *  to,
const char *  from,
apr_pool_t *  pool,
apr_iconv_t *  cd 
)

Create a conversion descriptor.

Parameters:
to name of charset to convert to.
from name of charset of the input bytes.
pool pool to alloc memory.
cd conversion descriptor created in pool.


Generated on Tue Nov 27 09:53:45 2007 for Apache Portable Runtime Iconv Library by  doxygen 1.5.2