## Xalan-C++ API Documentation

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

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

# XalanCAPI.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_CAPI_HEADER_GUARD_1357924680)
    00017 #define XALAN_CAPI_HEADER_GUARD_1357924680
    00018
    00019
    00020
    00021 #include <xalanc/XalanTransformer/XalanTransformerDefinitions.hpp>
    00022
    00023
    00024
    00035 #if defined(__cplusplus)
    00036 extern "C"
    00037 {
    00038 #endif
    00039
    00043     typedef void*           XalanHandle;
    00044
    00048     typedef const void*     XalanCSSHandle;
    00049
    00053     typedef const void*     XalanPSHandle;
    00054
    00059     typedef const char*     XalanCCharPtr;
    00060
    00064     typedef unsigned short  XalanUTF16Char;
    00065
    00074     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00075 #if defined(__cplusplus)
    00076     XalanInitialize();
    00077 #else
    00078     XalanInitialize(void);
    00079 #endif
    00080
    00102     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00103     XalanTerminate(int  fCleanUpICU);
    00104
    00110     XALAN_TRANSFORMER_EXPORT_FUNCTION(XalanHandle)
    00111     CreateXalanTransformer();
    00112
    00113
    00119     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00120     DeleteXalanTransformer(XalanHandle  theXalanHandle);
    00121
    00133     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00134     XalanTransformToFile(
    00135                 const char*     theXMLFileName,
    00136                 const char*     theXSLFileName,
    00137                 const char*     theOutFileName,
    00138                 XalanHandle     theXalanHandle);
    00139
    00151     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00152     XalanTransformToFilePrebuilt(
    00153             XalanPSHandle   theParsedSource,
    00154             XalanCSSHandle  theCSSHandle,
    00155             const char*     theOutFileName,
    00156             XalanHandle     theXalanHandle);
    00157
    00171     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00172     XalanTransformToData(
    00173             const char*     theXMLFileName,
    00174             const char*     theXSLFileName,
    00175             char**          theOutput,
    00176             XalanHandle     theXalanHandle);
    00177
    00191     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00192     XalanTransformToDataPrebuilt(
    00193                 XalanPSHandle   theParsedSource,
    00194                 XalanCSSHandle  theCSSHandle,
    00195                 char**          theOutput,
    00196                 XalanHandle     theXalanHandle);
    00197
    00204     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00205     XalanFreeData(char*     theData);
    00206
    00227     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00228     XalanTransformToHandler(
    00229                 const char*             theXMLFileName,
    00230                 const char*             theXSLFileName,
    00231                 XalanHandle             theXalanHandle,
    00232                 void*                   theOutputHandle,
    00233                 XalanOutputHandlerType  theOutputHandler,
    00234                 XalanFlushHandlerType   theFlushHandler);
    00235
    00256     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00257     XalanTransformToHandlerPrebuilt(
    00258                 XalanPSHandle           thePSHandle,
    00259                 XalanCSSHandle          theCSSHandle,
    00260                 XalanHandle             theXalanHandle,
    00261                 void*                   theOutputHandle,
    00262                 XalanOutputHandlerType  theOutputHandler,
    00263                 XalanFlushHandlerType   theFlushHandler);
    00264
    00273     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00274     XalanCompileStylesheet(
    00275             const char*         theXSLFileName,
    00276             XalanHandle         theXalanHandle,
    00277             XalanCSSHandle*     theCSSHandle);
    00278
    00288     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00289     XalanCompileStylesheetFromStream(
    00290             const char*         theXSLStream,
    00291             unsigned long       theXSLStreamLength,
    00292             XalanHandle         theXalanHandle,
    00293             XalanCSSHandle*     theCSSHandle);
    00294
    00302     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00303     XalanDestroyCompiledStylesheet(
    00304             XalanCSSHandle  theCSSHandle,
    00305             XalanHandle     theXalanHandle);
    00306
    00315     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00316     XalanParseSource(
    00317             const char*     theXMLFileName,
    00318             XalanHandle     theXalanHandle,
    00319             XalanPSHandle*  thePSHandle);
    00320
    00330     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00331     XalanParseSourceFromStream(
    00332             const char*     theXMLStream,
    00333             unsigned long   theXMLStreamLength,
    00334             XalanHandle     theXalanHandle,
    00335             XalanPSHandle*  thePSHandle);
    00336
    00345     XALAN_TRANSFORMER_EXPORT_FUNCTION(int)
    00346     XalanDestroyParsedSource(
    00347             XalanPSHandle   thePSHandle,
    00348             XalanHandle     theXalanHandle);
    00349
    00358     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00359     XalanSetStylesheetParam(
    00360                 const char*     key,
    00361                 const char*     expression,
    00362                 XalanHandle     theXalanHandle);
    00363
    00373     XALAN_TRANSFORMER_EXPORT_FUNCTION(void)
    00374     XalanSetStylesheetParamUTF(
    00375                 const XalanUTF16Char*   key,
    00376                 const XalanUTF16Char*   expression,
    00377                 XalanHandle             theXalanHandle);
    00378
    00389     XALAN_TRANSFORMER_EXPORT_FUNCTION(XalanCCharPtr)
    00390     XalanGetLastError(XalanHandle   theXalanHandle);
    00391
    00392 #if defined(__cplusplus)
    00393 }
    00394 #endif
    00395
    00396
    00397
    00398 #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.9 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.