Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

XalanCAPI.h File Reference

Include dependency graph for XalanCAPI.h:

Include dependency graph

Defines

Typedefs

Functions


Define Documentation

#define XALAN_CAPI_HEADER_GUARD_1357924680
 


Typedef Documentation

typedef const char* XalanCCharPtr
 

This is a typedef to work around limitations with the XALAN_TRANSFORMER_EXPORT_FUNCTION macro.

typedef const void* XalanCSSHandle
 

Handle used to store the address of Compiled Stylesheet instance.

typedef void* XalanHandle
 

Handle used to store the address of XalanTransformer instance.

typedef const void* XalanPSHandle
 

Handle used to store the address of Parsed Source instance.


Function Documentation

XALAN_TRANSFORMER_EXPORT_FUNCTION ( void ) const
 

Set a top-level stylesheet parameter.

This value can be evaluated via xsl:param-variable.

Parameters:
key   name of the param
expression   expression that will be evaluated
theXalanHandle   handle of XalanTransformer instance.

XALAN_TRANSFORMER_EXPORT_FUNCTION ( int )
 

Transform the XML source tree to a dynamically allocated buffer.

The processor will apply the compiled stylesheet to the input file and assign the address of the dynamically allocated result to a user supplied pointer. The user must call XalanFreeData with the this pointer.

Parameters:
theXMLFileName   filename of XML input source
theCSSHandle   handle of compiled stylesheet
theOutput   a pointer to a char*
theXalanHandle   handle of XalanTransformer instance.
Returns:
0 for success

XALAN_TRANSFORMER_EXPORT_FUNCTION ( int ) const
 

Transform the XML source tree to the given result file.

The processor will apply the stylesheet file to the input file and write the transformation result to a new output file.

Parameters:
theXMLFileName   filename of XML input source
theXSLFileName   filename of stylesheet source
theOutFileName   filename of output source
theXalanHandle   handle of XalanTransformer instance.
Returns:
0 for success

XALAN_TRANSFORMER_EXPORT_FUNCTION ( XalanHandle )
 

Create a XalanTransformer instance.

Returns:
the XalanTransformer handle

XALAN_TRANSFORMER_EXPORT_FUNCTION ( void )
 

Initialize Xerces and Xalan.

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

Interpreting class diagrams

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

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.