Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XPathCAPI.h
Go to the documentation of this file.
1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #if !defined(XALAN_XPATHCAPI_HEADER_GUARD_1357924680)
17 #define XALAN_XPATHCAPI_HEADER_GUARD_1357924680
18 
19 
20 
21 #if defined(_MSC_VER)
22 
23 #if defined(XALAN_XPATHCAPI_BUILD_DLL)
24 
25 #define XALAN_XPATHCAPI_EXPORT __declspec(dllexport)
26 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T __declspec(dllexport)
27 
28 #else
29 
30 #define XALAN_XPATHCAPI_EXPORT __declspec(dllimport)
31 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T __declspec(dllimport)
32 
33 #endif
34 
35 #else
36 
37 #define XALAN_XPATHCAPI_EXPORT
38 #define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T
39 
40 #endif
41 
42 
43 
50 #if defined(__cplusplus)
51 extern "C"
52 {
53 #endif
54 
55 #define XALAN_XPATH_API_SUCCESS 0
56 #define XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED 1
57 #define XALAN_XPATH_API_ERROR_ALREADY_TERMINATED 2
58 #define XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED 3
59 #define XALAN_XPATH_API_ERROR_TERMINATION_FAILED 4
60 #define XALAN_XPATH_API_ERROR_NOT_INITIALIZED 5
61 #define XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE 6
62 #define XALAN_XPATH_API_ERROR_INVALID_PARAMETER 7
63 #define XALAN_XPATH_API_ERROR_INVALID_EXPRESSION 8
64 #define XALAN_XPATH_API_ERROR_BAD_XML 9
65 #define XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING 10
66 #define XALAN_XPATH_API_ERROR_TRANSCODING 11
67 #define XALAN_XPATH_API_ERROR_INVALID_XPATH 12
68 #define XALAN_XPATH_API_ERROR_UNKNOWN 13
69 
70 
75 
79 typedef void* XalanXPathHandle;
80 
81 
82 #if defined(OS390)
83 #pragma export(XalanXPathAPIInitialize)
84 #pragma export(XalanXPathAPITerminate)
85 #pragma export(XalanCreateXPathEvaluator)
86 #pragma export(XalanDestroyXPathEvaluator)
87 #pragma export(XalanCreateXPath)
88 #pragma export(XalanDestroyXPath)
89 #pragma export(XalanEvaluateXPathAsBoolean)
90 #pragma export(XalanEvaluateXPathExpressionAsBoolean)
91 #endif
92 
103 
116 
124 XalanCreateXPathEvaluator(XalanXPathEvaluatorHandle* theHandle);
125 
133 XalanDestroyXPathEvaluator(XalanXPathEvaluatorHandle theXalanHandle);
134 
146  XalanXPathEvaluatorHandle theXalanHandle,
147  const char* theXPathExpression,
148  const char* theXPathExpressionEncoding,
149  XalanXPathHandle* theXPathHandle);
150 
160  XalanXPathEvaluatorHandle theXalanHandle,
161  XalanXPathHandle theXPathHandle);
162 
174  XalanXPathEvaluatorHandle theXalanHandle,
175  XalanXPathHandle theXPathHandle,
176  const char* theXML,
177  int* theResult);
178 
191  XalanXPathEvaluatorHandle theXalanHandle,
192  const char* theXPathExpression,
193  const char* theXPathExpressionEncoding,
194  const char* theXML,
195  int* theResult);
196 
197 #if defined(__cplusplus)
198 }
199 #endif
200 
201 
202 
203 #endif
int XalanDestroyXPathEvaluator(XalanXPathEvaluatorHandle theXalanHandle)
Destroy a XalanXPathEvaluator instance.
int XalanCreateXPathEvaluator(XalanXPathEvaluatorHandle *theHandle)
Create a XalanXPathEvaluator instance.
int XalanEvaluateXPathExpressionAsBoolean(XalanXPathEvaluatorHandle theXalanHandle, const char *theXPathExpression, const char *theXPathExpressionEncoding, const char *theXML, int *theResult)
Evaluates an XPath expression.
int XalanCreateXPath(XalanXPathEvaluatorHandle theXalanHandle, const char *theXPathExpression, const char *theXPathExpressionEncoding, XalanXPathHandle *theXPathHandle)
Creates a compiled XPath instance.
void * XalanXPathHandle
Handle used to store the address of compiled XPath instance.
Definition: XPathCAPI.h:79
int XalanXPathAPITerminate()
Terminate Xerces and the XPath API.
#define XALAN_XPATHCAPI_EXPORT_FUNCTION(T)
Definition: XPathCAPI.h:38
void * XalanXPathEvaluatorHandle
Handle used to store the address of XalanTransformer instance.
Definition: XPathCAPI.h:74
int XalanEvaluateXPathAsBoolean(XalanXPathEvaluatorHandle theXalanHandle, XalanXPathHandle theXPathHandle, const char *theXML, int *theResult)
Evaluates a compiled XPath instance.
int XalanDestroyXPath(XalanXPathEvaluatorHandle theXalanHandle, XalanXPathHandle theXPathHandle)
Destroys a compiled XPath instance.
int XalanXPathAPIInitialize()
Initialize Xerces and the XPath API.

Interpreting class diagrams

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

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo