## Xalan-C++ API Documentation

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

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  * Copyright 1999-2004 The Apache Software Foundation.
    00003  *
    00004  * Licensed under the Apache License, Version 2.0 (the "License");
    00005  * you may not use this file except in compliance with the License.
    00006  * You may obtain a copy of the License at
    00007  *
    00008  *     http://www.apache.org/licenses/LICENSE-2.0
    00009  *
    00010  * Unless required by applicable law or agreed to in writing, software
    00011  * distributed under the License is distributed on an "AS IS" BASIS,
    00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    00013  * See the License for the specific language governing permissions and
    00014  * limitations under the License.
    00015  */
    00016 #if !defined(XALAN_XPATHCAPI_HEADER_GUARD_1357924680)
    00017 #define XALAN_XPATHCAPI_HEADER_GUARD_1357924680
    00018
    00019
    00020
    00021 #if defined(_MSC_VER)
    00022
    00023 #if defined(XALAN_XPATHCAPI_BUILD_DLL)
    00024
    00025 #define XALAN_XPATHCAPI_EXPORT __declspec(dllexport)
    00026 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T __declspec(dllexport)
    00027
    00028 #else
    00029
    00030 #define XALAN_XPATHCAPI_EXPORT __declspec(dllimport)
    00031 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T __declspec(dllimport)
    00032
    00033 #endif
    00034
    00035 #else
    00036
    00037 #define XALAN_XPATHCAPI_EXPORT
    00038 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T
    00039
    00040 #endif
    00041
    00042
    00043
    00050 #if defined(__cplusplus)
    00051 extern "C"
    00052 {
    00053 #endif
    00054
    00055 #define XALAN_XPATH_API_SUCCESS                     0
    00056 #define XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED   1
    00057 #define XALAN_XPATH_API_ERROR_ALREADY_TERMINATED    2
    00058 #define XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED 3
    00059 #define XALAN_XPATH_API_ERROR_TERMINATION_FAILED    4
    00060 #define XALAN_XPATH_API_ERROR_NOT_INITIALIZED       5
    00061 #define XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE   6
    00062 #define XALAN_XPATH_API_ERROR_INVALID_PARAMETER     7
    00063 #define XALAN_XPATH_API_ERROR_INVALID_EXPRESSION    8
    00064 #define XALAN_XPATH_API_ERROR_BAD_XML               9
    00065 #define XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING  10
    00066 #define XALAN_XPATH_API_ERROR_TRANSCODING           11
    00067 #define XALAN_XPATH_API_ERROR_INVALID_XPATH         12
    00068 #define XALAN_XPATH_API_ERROR_UNKNOWN               13
    00069
    00070
    00074 typedef void*   XalanXPathEvaluatorHandle;
    00075
    00079 typedef void*   XalanXPathHandle;
    00080
    00081
    00082 #if defined(OS390)
    00083 #pragma export(XalanXPathAPIInitialize)
    00084 #pragma export(XalanXPathAPITerminate)
    00085 #pragma export(XalanCreateXPathEvaluator)
    00086 #pragma export(XalanDestroyXPathEvaluator)
    00087 #pragma export(XalanCreateXPath)
    00088 #pragma export(XalanDestroyXPath)
    00089 #pragma export(XalanEvaluateXPathAsBoolean)
    00090 #pragma export(XalanEvaluateXPathExpressionAsBoolean)
    00091 #endif
    00092
    00101 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00102 XalanXPathAPIInitialize();
    00103
    00114 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00115 XalanXPathAPITerminate();
    00116
    00123 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00124 XalanCreateXPathEvaluator(XalanXPathEvaluatorHandle*    theHandle);
    00125
    00132 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00133 XalanDestroyXPathEvaluator(XalanXPathEvaluatorHandle    theXalanHandle);
    00134
    00144 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00145 XalanCreateXPath(
    00146             XalanXPathEvaluatorHandle   theXalanHandle,
    00147             const char*                 theXPathExpression,
    00148             const char*                 theXPathExpressionEncoding,
    00149             XalanXPathHandle*           theXPathHandle);
    00150
    00158 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00159 XalanDestroyXPath(
    00160             XalanXPathEvaluatorHandle   theXalanHandle,
    00161             XalanXPathHandle            theXPathHandle);
    00162
    00172 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00173 XalanEvaluateXPathAsBoolean(
    00174             XalanXPathEvaluatorHandle   theXalanHandle,
    00175             XalanXPathHandle            theXPathHandle,
    00176             const char*                 theXML,
    00177             int*                        theResult);
    00178
    00189 XALAN_XPATHCAPI_EXPORT_FUNCTION(int)
    00190 XalanEvaluateXPathExpressionAsBoolean(
    00191             XalanXPathEvaluatorHandle   theXalanHandle,
    00192             const char*                 theXPathExpression,
    00193             const char*                 theXPathExpressionEncoding,
    00194             const char*                 theXML,
    00195             int*                        theResult);
    00196
    00197 #if defined(__cplusplus)
    00198 }
    00199 #endif
    00200
    00201
    00202
    00203 #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.10 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.