Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Defines | Typedefs | Functions

XPathCAPI.h File Reference

Go to the source code of this file.

Defines

Typedefs

Functions


Define Documentation

#define XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED   1

Definition at line 58 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_ALREADY_TERMINATED   2

Definition at line 59 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_BAD_XML   9

Definition at line 66 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE   6

Definition at line 63 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED   3

Definition at line 60 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_INVALID_EXPRESSION   8

Definition at line 65 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_INVALID_PARAMETER   7

Definition at line 64 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_INVALID_XPATH   12

Definition at line 69 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_NOT_INITIALIZED   5

Definition at line 62 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_TERMINATION_FAILED   4

Definition at line 61 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_TRANSCODING   11

Definition at line 68 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_UNKNOWN   13

Definition at line 70 of file XPathCAPI.h.

#define XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING   10

Definition at line 67 of file XPathCAPI.h.

#define XALAN_XPATH_API_SUCCESS   0

This is a simple C interface for the class XPathEvaluator.

It's the user's responsibility to call XalanXPathAPIInitialize() before making any other API calls, and to call XalanXPathAPITerminate() when finished with the API.

Definition at line 57 of file XPathCAPI.h.

#define XALAN_XPATHCAPI_EXPORT

Definition at line 39 of file XPathCAPI.h.

#define XALAN_XPATHCAPI_EXPORT_FUNCTION (   T  )     T

Definition at line 40 of file XPathCAPI.h.


Typedef Documentation

Handle used to store the address of XalanTransformer instance.

Definition at line 76 of file XPathCAPI.h.

typedef void* XalanXPathHandle

Handle used to store the address of compiled XPath instance.

Definition at line 81 of file XPathCAPI.h.


Function Documentation

int XalanCreateXPath ( XalanXPathEvaluatorHandle  theXalanHandle,
const char *  theXPathExpression,
const char *  theXPathExpressionEncoding,
XalanXPathHandle theXPathHandle 
)

Creates a compiled XPath instance.

Parameters:
theXalanHandle The handle of XalanXPathEvaluatorHandle instance.
theXPathExpression The expression to compile
theXPathExpressionEncoding The encoding of the expression. If NULL or an empty string, the local code page is assumed.
theXPathHandle A pointer to the handle for the new instance
Returns:
0 for success, or a non-zero error code upon failure
int XalanCreateXPathEvaluator ( XalanXPathEvaluatorHandle theHandle  ) 

Create a XalanXPathEvaluator instance.

Parameters:
theXalanHandle A pointer to the handle for the new instance.
Returns:
0 for success, or a non-zero error code upon failure
int XalanDestroyXPath ( XalanXPathEvaluatorHandle  theXalanHandle,
XalanXPathHandle  theXPathHandle 
)

Destroys a compiled XPath instance.

Parameters:
theXalanHandle The handle of XalanXPathEvaluatorHandle instance.
theXPathHandle The handle of XPath instance
Returns:
0 for success, or a non-zero error code upon failure
int XalanDestroyXPathEvaluator ( XalanXPathEvaluatorHandle  theXalanHandle  ) 

Destroy a XalanXPathEvaluator instance.

Parameters:
theXalanHandle The handle of the instance to destroy.
Returns:
0 for success, or a non-zero error code upon failure
int XalanEvaluateXPathAsBoolean ( XalanXPathEvaluatorHandle  theXalanHandle,
XalanXPathHandle  theXPathHandle,
const char *  theXML,
int *  theResult 
)

Evaluates a compiled XPath instance.

Parameters:
theXalanHandle The handle of XalanXPathEvaluatorHandle instance.
theXPathHandle The pointer to handle for instance
theXML The XML document to use for evaluating the XPath expression
theResult A pointer to an int to receive the result.
Returns:
0 for success, or a non-zero error code upon failure
int XalanEvaluateXPathExpressionAsBoolean ( XalanXPathEvaluatorHandle  theXalanHandle,
const char *  theXPathExpression,
const char *  theXPathExpressionEncoding,
const char *  theXML,
int *  theResult 
)

Evaluates an XPath expression.

Parameters:
theXalanHandle The handle of XalanXPathEvaluatorHandle instance.
theXPathExpression The expression to evaluate
theXPathExpressionEncoding The encoding of the expression. If NULL or an empty string, the local code page is assumed.
theXML The XML document to use for evaluating the XPath expression
theResult A pointer to an int to receive the result.
Returns:
0 for success, or a non-zero error code upon failure
int XalanXPathAPIInitialize (  ) 

Initialize Xerces and the XPath API.

Should be called only once per process before making any other API calls.

Returns:
0 for success, or a non-zero error code upon failure
int XalanXPathAPITerminate (  ) 

Terminate Xerces and the XPath API.

Should be called only once per process after deleting all instances of XalanXPathEvaluator. Once a process has called this function, it cannot use the API for the remaining lifetime of the process.

Returns:
0 for success, or a non-zero error code upon failure

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.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo