## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.5

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XPathCAPI.h

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  *
    00005  * Copyright (c) 2001 The Apache Software Foundation.  All rights
    00006  * reserved.
    00007  *
    00008  * Redistribution and use in source and binary forms, with or without
    00009  * modification, are permitted provided that the following conditions
    00010  * are met:
    00011  *
    00012  * 1. Redistributions of source code must retain the above copyright
    00013  *    notice, this list of conditions and the following disclaimer.
    00014  *
    00015  * 2. Redistributions in binary form must reproduce the above copyright
    00016  *    notice, this list of conditions and the following disclaimer in
    00017  *    the documentation and/or other materials provided with the
    00018  *    distribution.
    00019  *
    00020  * 3. The end-user documentation included with the redistribution,
    00021  *    if any, must include the following acknowledgment:
    00022  *       "This product includes software developed by the
    00023  *        Apache Software Foundation (http://www.apache.org/)."
    00024  *    Alternately, this acknowledgment may appear in the software itself,
    00025  *    if and wherever such third-party acknowledgments normally appear.
    00026  *
    00027  * 4. The names "Xalan" and "Apache Software Foundation" must
    00028  *    not be used to endorse or promote products derived from this
    00029  *    software without prior written permission. For written
    00030  *    permission, please contact apache@apache.org.
    00031  *
    00032  * 5. Products derived from this software may not be called "Apache",
    00033  *    nor may "Apache" appear in their name, without prior written
    00034  *    permission of the Apache Software Foundation.
    00035  *
    00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00047  * SUCH DAMAGE.
    00048  * ====================================================================
    00049  *
    00050  * This software consists of voluntary contributions made by many
    00051  * individuals on behalf of the Apache Software Foundation and was
    00052  * originally based on software copyright (c) 1999, International
    00053  * Business Machines, Inc., http://www.ibm.com.  For more
    00054  * information on the Apache Software Foundation, please see
    00055  * <http://www.apache.org/>.
    00056  */
    00057 #if !defined(XALAN_XPATHCAPI_HEADER_GUARD_1357924680)
    00058 #define XALAN_XPATHCAPI_HEADER_GUARD_1357924680
    00059
    00060
    00061
    00062 #if defined(_MSC_VER)
    00063
    00064 #if defined(XALAN_XPATHCAPI_BUILD_DLL)
    00065
    00066 #define XALAN_XPATHCAPI_EXPORT __declspec(dllexport)
    00067 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T __declspec(dllexport)
    00068
    00069 #else
    00070
    00071 #define XALAN_XPATHCAPI_EXPORT __declspec(dllimport)
    00072 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T __declspec(dllimport)
    00073
    00074 #endif
    00075
    00076 #else
    00077
    00078 #define XALAN_XPATHCAPI_EXPORT
    00079 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T
    00080
    00081 #endif
    00082
    00083
    00084
    00091 #if defined(__cplusplus)
    00092 extern "C"
    00093 {
    00094 #endif
    00095
    00096 #define XALAN_XPATH_API_SUCCESS                     0
    00097 #define XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED   1
    00098 #define XALAN_XPATH_API_ERROR_ALREADY_TERMINATED    2
    00099 #define XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED 3
    00100 #define XALAN_XPATH_API_ERROR_TERMINATION_FAILED    4
    00101 #define XALAN_XPATH_API_ERROR_NOT_INITIALIZED       5
    00102 #define XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE   6
    00103 #define XALAN_XPATH_API_ERROR_INVALID_PARAMETER     7
    00104 #define XALAN_XPATH_API_ERROR_INVALID_EXPRESSION    8
    00105 #define XALAN_XPATH_API_ERROR_BAD_XML               9
    00106 #define XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING  10
    00107 #define XALAN_XPATH_API_ERROR_TRANSCODING           11
    00108 #define XALAN_XPATH_API_ERROR_INVALID_XPATH         12
    00109 #define XALAN_XPATH_API_ERROR_UNKNOWN               13
    00110
    00111
    00115 typedef void*   XalanXPathEvaluatorHandle;
    00116
    00120 typedef void*   XalanXPathHandle;
    00121
    00122
    00123 #if defined(OS390)
    00124 #pragma export(XalanXPathAPIInitialize)
    00125 #pragma export(XalanXPathAPITerminate)
    00126 #pragma export(XalanCreateXPathEvaluator)
    00127 #pragma export(XalanDestroyXPathEvaluator)
    00128 #pragma export(XalanCreateXPath)
    00129 #pragma export(XalanDestroyXPath)
    00130 #pragma export(XalanEvaluateXPathAsBoolean)
    00131 #pragma export(XalanEvaluateXPathExpressionAsBoolean)
    00132 #endif
    00133
    00142 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00143 XalanXPathAPIInitialize();
    00144
    00155 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00156 XalanXPathAPITerminate();
    00157
    00164 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00165 XalanCreateXPathEvaluator(XalanXPathEvaluatorHandle*    theHandle);
    00166
    00173 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00174 XalanDestroyXPathEvaluator(XalanXPathEvaluatorHandle    theXalanHandle);
    00175
    00185 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00186 XalanCreateXPath(
    00187             XalanXPathEvaluatorHandle   theXalanHandle,
    00188             const char*                 theXPathExpression,
    00189             const char*                 theXPathExpressionEncoding,
    00190             XalanXPathHandle*           theXPathHandle);
    00191
    00199 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00200 XalanDestroyXPath(
    00201             XalanXPathEvaluatorHandle   theXalanHandle,
    00202             XalanXPathHandle            theXPathHandle);
    00203
    00213 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00214 XalanEvaluateXPathAsBoolean(
    00215             XalanXPathEvaluatorHandle   theXalanHandle,
    00216             XalanXPathHandle            theXPathHandle,
    00217             const char*                 theXML,
    00218             int*                        theResult);
    00219
    00230 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00231 XalanEvaluateXPathExpressionAsBoolean(
    00232             XalanXPathEvaluatorHandle   theXalanHandle,
    00233             const char*                 theXPathExpression,
    00234             const char*                 theXPathExpressionEncoding,
    00235             const char*                 theXML,
    00236             int*                        theResult);
    00237
    00238 #if defined(__cplusplus)
    00239 }
    00240 #endif
    00241
    00242
    00243
    00244 #endif

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.5 Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.