include/api_version.h File Reference

APR-iconv Versioning Interface. More...

#include "apr_version.h"
#include "apr_iconv.h"

Go to the source code of this file.

Defines

#define API_MAJOR_VERSION   1
#define API_MINOR_VERSION   2
#define API_PATCH_VERSION   1
#define API_IS_DEV_STRING   "-dev"
#define API_STRINGIFY(n)   API_STRINGIFY_HELPER(n)
#define API_STRINGIFY_HELPER(n)   #n
#define API_VERSION_STRING
#define API_VERSION_STRING_CSV

Functions

void api_version (apr_version_t *pvsn)
const char * api_version_string (void)


Detailed Description

APR-iconv Versioning Interface.

APR-iconv's Version

There are several different mechanisms for accessing the version. There is a string form, and a set of numbers; in addition, there are constants which can be compiled into your application, and you can query the library being used for its actual version.

Note that it is possible for an application to detect that it has been compiled against a different version of API by use of the compile-time constants and the use of the run-time query function.

API version numbering follows the guidelines specified in:

http://apr.apache.org/versioning.html


Define Documentation

#define API_IS_DEV_STRING   "-dev"

Internal: string form of the "is dev" flag

#define API_MAJOR_VERSION   1

major version Major API changes that could cause compatibility problems for older programs such as structure size changes. No binary compatibility is possible across a change in the major version.

#define API_MINOR_VERSION   2

minor version Minor API changes that do not cause binary compatibility problems. Reset to 0 when upgrading API_MAJOR_VERSION

#define API_PATCH_VERSION   1

patch level The Patch Level never includes API changes, simply bug fixes. Reset to 0 when upgrading API_MINOR_VERSION

#define API_STRINGIFY (  )     API_STRINGIFY_HELPER(n)

Properly quote a value as a string in the C preprocessor

#define API_STRINGIFY_HELPER (  )     #n

Helper macro for API_STRINGIFY

#define API_VERSION_STRING

Value:

The formatted string of API's version

#define API_VERSION_STRING_CSV

Value:

API_MAJOR_VERSION ##, \
                             ##API_MINOR_VERSION ##, \
                             ##API_PATCH_VERSION
An alternative formatted string of APR's version


Function Documentation

void api_version ( apr_version_t *  pvsn  ) 

Return APR-iconv's version information information in a numeric form.

Parameters:
pvsn Pointer to a version structure for returning the version information.

const char* api_version_string ( void   ) 

Return API's version information as a string.


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