Files
apache-http-server/include/util_charset.h
Christophe Jaillet f791c1b710 Move comment from .c to .h in order to make use of it in doxygen.
Fix the comment that states that these vars are NULL on ASCII machine, they seem to be undefined instead.
Rework some comments.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1611916 13f79535-47bb-0310-9956-ffa450edef68
2014-07-19 13:36:52 +00:00

73 lines
2.2 KiB
C

/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file util_charset.h
* @brief charset conversion
*
* @defgroup APACHE_CORE_CHARSET Charset Conversion
* @ingroup APACHE_CORE
*
* These are the translation handles used to translate between the network
* format of protocol headers and the local machine format.
*
* For an EBCDIC machine, these are valid handles which are set up at
* initialization to translate between ISO-8859-1 and the code page of
* the source code.\n
* For an ASCII machine, they are undefined.
*
* @see ap_init_ebcdic()
* @{
*/
#ifndef APACHE_UTIL_CHARSET_H
#define APACHE_UTIL_CHARSET_H
#ifdef __cplusplus
extern "C" {
#endif
#include "apr.h"
#if APR_CHARSET_EBCDIC || defined(DOXYGEN)
#include "apr_xlate.h"
/**
* On EBCDIC machine this is a translation handle used to translate the
* headers from the local machine format to ASCII for network transmission.
* @note On ASCII system, this variable does <b>not</b> exist.
* So, its use should be guarded by \#if APR_CHARSET_EBCDIC.
*/
extern apr_xlate_t *ap_hdrs_to_ascii;
/**
* On EBCDIC machine this is a translation handle used to translate the
* headers from ASCII to the local machine format after network transmission.
* @note On ASCII system, this variable does <b>not</b> exist.
* So, its use should be guarded by \#if APR_CHARSET_EBCDIC.
*/
extern apr_xlate_t *ap_hdrs_from_ascii;
#endif /* APR_CHARSET_EBCDIC */
#ifdef __cplusplus
}
#endif
#endif /* !APACHE_UTIL_CHARSET_H */
/** @} */