## 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

# XalanCAPI.h

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  *
    00005  * Copyright (c) 2000-2002 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_CAPI_HEADER_GUARD_1357924680)
    00058 #define XALAN_CAPI_HEADER_GUARD_1357924680
    00059
    00060
    00061
    00062 #include <XalanTransformer/XalanTransformerDefinitions.hpp>
    00063
    00064
    00065
    00076 #if defined(__cplusplus)
    00077 extern "C"
    00078 {
    00079 #endif
    00080
    00084     typedef void*           XalanHandle;
    00085
    00089     typedef const void*     XalanCSSHandle;
    00090
    00094     typedef const void*     XalanPSHandle;
    00095
    00100     typedef const char*     XalanCCharPtr;
    00101
    00105     typedef unsigned short  XalanUTF16Char;
    00106
    00115     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00116 #if defined(__cplusplus)
    00117     XalanInitialize();
    00118 #else
    00119     XalanInitialize(void);
    00120 #endif
    00121
    00143     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00144     XalanTerminate(int  fCleanUpICU);
    00145
    00151     XALAN_TRANSFORMER_EXPORT_FUNCTION(XalanHandle)
    00152 #if defined(__cplusplus)
    00153     CreateXalanTransformer();
    00154 #else
    00155     CreateXalanTransformer(void);
    00156 #endif
    00157
    00163     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00164     DeleteXalanTransformer(XalanHandle  theXalanHandle);
    00165
    00177     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00178     XalanTransformToFile(
    00179                 const char*     theXMLFileName,
    00180                 const char*     theXSLFileName,
    00181                 const char*     theOutFileName,
    00182                 XalanHandle     theXalanHandle);
    00183
    00195     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00196     XalanTransformToFilePrebuilt(
    00197             XalanPSHandle   theParsedSource,
    00198             XalanCSSHandle  theCSSHandle,
    00199             const char*     theOutFileName,
    00200             XalanHandle     theXalanHandle);
    00201
    00215     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00216     XalanTransformToData(
    00217             const char*     theXMLFileName,
    00218             const char*     theXSLFileName,
    00219             char**          theOutput,
    00220             XalanHandle     theXalanHandle);
    00221
    00235     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00236     XalanTransformToDataPrebuilt(
    00237                 XalanPSHandle   theParsedSource,
    00238                 XalanCSSHandle  theCSSHandle,
    00239                 char**          theOutput,
    00240                 XalanHandle     theXalanHandle);
    00241
    00248     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00249     XalanFreeData(char*     theData);
    00250
    00271     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00272     XalanTransformToHandler(
    00273                 const char*             theXMLFileName,
    00274                 const char*             theXSLFileName,
    00275                 XalanHandle             theXalanHandle,
    00276                 void*                   theOutputHandle,
    00277                 XalanOutputHandlerType  theOutputHandler,
    00278                 XalanFlushHandlerType   theFlushHandler);
    00279
    00300     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00301     XalanTransformToHandlerPrebuilt(
    00302                 XalanPSHandle           thePSHandle,
    00303                 XalanCSSHandle          theCSSHandle,
    00304                 XalanHandle             theXalanHandle,
    00305                 void*                   theOutputHandle,
    00306                 XalanOutputHandlerType  theOutputHandler,
    00307                 XalanFlushHandlerType   theFlushHandler);
    00308
    00317     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00318     XalanCompileStylesheet(
    00319             const char*         theXSLFileName,
    00320             XalanHandle         theXalanHandle,
    00321             XalanCSSHandle*     theCSSHandle);
    00322
    00332     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00333     XalanCompileStylesheetFromStream(
    00334             const char*         theXSLStream,
    00335             unsigned long       theXSLStreamLength,
    00336             XalanHandle         theXalanHandle,
    00337             XalanCSSHandle*     theCSSHandle);
    00338
    00346     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00347     XalanDestroyCompiledStylesheet(
    00348             XalanCSSHandle  theCSSHandle,
    00349             XalanHandle     theXalanHandle);
    00350
    00359     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00360     XalanParseSource(
    00361             const char*     theXMLFileName,
    00362             XalanHandle     theXalanHandle,
    00363             XalanPSHandle*  thePSHandle);
    00364
    00374     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00375     XalanParseSourceFromStream(
    00376             const char*     theXMLStream,
    00377             unsigned long   theXMLStreamLength,
    00378             XalanHandle     theXalanHandle,
    00379             XalanPSHandle*  thePSHandle);
    00380
    00389     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00390     XalanDestroyParsedSource(
    00391             XalanPSHandle   thePSHandle,
    00392             XalanHandle     theXalanHandle);
    00393
    00402     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00403     XalanSetStylesheetParam(
    00404                 const char*     key,
    00405                 const char*     expression,
    00406                 XalanHandle     theXalanHandle);
    00407
    00417     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00418     XalanSetStylesheetParamUTF(
    00419                 const XalanUTF16Char*   key,
    00420                 const XalanUTF16Char*   expression,
    00421                 XalanHandle             theXalanHandle);
    00422
    00433     XALAN_TRANSFORMER_EXPORT_FUNCTION(XalanCCharPtr)
    00434     XalanGetLastError(XalanHandle   theXalanHandle);
    00435
    00436 #if defined(__cplusplus)
    00437 }
    00438 #endif
    00439
    00440
    00441
    00442 #endif  // XALAN_CAPI_HEADER_GUARD_1357924680

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.