| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <title>Xalan-C++ API : Main Page</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <!-- The head section is copied from Doxygen 1.7.1 generated default output --> |
| <body> |
| <h2 align="center">Xalan-C++ API Documentation</h2> |
| <h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3> |
| <hr/> |
| <!-- Generated by Doxygen 1.7.1 --> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <h1>XalanCAPI.h File Reference</h1> </div> |
| </div> |
| <div class="contents"> |
| <code>#include <<a class="el" href="XalanTransformerDefinitions_8hpp_source.html">xalanc/XalanTransformer/XalanTransformerDefinitions.hpp</a>></code><br/> |
| <div class="dynheader"> |
| Include dependency graph for XalanCAPI.h:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="XalanCAPI_8h__incl.png" border="0" usemap="#XalanCAPI_8h" alt=""/></div> |
| <map name="XalanCAPI_8h" id="XalanCAPI_8h"> |
| <area shape="rect" id="node3" href="XalanTransformerDefinitions_8hpp.html" title="xalanc/XalanTransformer/XalanTransformerDefinitions.hpp" alt="" coords="315,83,709,112"/><area shape="rect" id="node5" href="PlatformDefinitions_8hpp.html" title="xalanc/Include/PlatformDefinitions.hpp" alt="" coords="284,160,548,189"/><area shape="rect" id="node11" href="XalanVersion_8hpp.html" title="XalanVersion.hpp" alt="" coords="549,237,683,267"/></map> |
| </div> |
| |
| <p><a href="XalanCAPI_8h_source.html">Go to the source code of this file.</a></p> |
| <h2><a name="typedef-members"></a> |
| Typedefs</h2> |
| <ul> |
| <li>typedef void * <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> |
| <dl class="el"><dd class="mdescRight">This is a simple C interface for the class <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a>. <a href="#a6424447ecce5f073d80d0ace8d02de62"></a><br/></dl><li>typedef const void * <a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> |
| <dl class="el"><dd class="mdescRight">Handle used to store the address of Compiled <a class="el" href="classStylesheet.html" title="This class represents the base stylesheet or an "import" stylesheet.">Stylesheet</a> instance. <a href="#a367a66f86fbd6d3daddc00301f464826"></a><br/></dl><li>typedef const void * <a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> |
| <dl class="el"><dd class="mdescRight">Handle used to store the address of Parsed Source instance. <a href="#a4ca803a3e0e455959507c331cac963be"></a><br/></dl><li>typedef const char * <a class="el" href="XalanCAPI_8h.html#a75c525e2f83732b3dab062d9a733c112">XalanCCharPtr</a> |
| <dl class="el"><dd class="mdescRight">This is a typedef to work around limitations with the XALAN_TRANSFORMER_EXPORT_FUNCTION macro. <a href="#a75c525e2f83732b3dab062d9a733c112"></a><br/></dl><li>typedef XMLCh <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> |
| <dl class="el"><dd class="mdescRight">This is a typedef for characters encoded in UTF-16. <a href="#a90a51ed8db9b99c8edfcf14f2ccd9cc8"></a><br/></dl></ul> |
| <h2><a name="func-members"></a> |
| Functions</h2> |
| <ul> |
| <li><a class="el" href="XalanCAPI_8h.html#ab76ae2cf99f71186eedd9013065de0f2">XalanInitialize</a> (void) |
| <dl class="el"><dd class="mdescRight">Initialize Xerces and Xalan. <a href="#ab76ae2cf99f71186eedd9013065de0f2"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#aa0260637cdabb76203273d0e399263e2">XalanTerminate</a> (int fCleanUpICU) |
| <dl class="el"><dd class="mdescRight">Terminate Xalan and Xerces. <a href="#aa0260637cdabb76203273d0e399263e2"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a1b76c8e523232e033ccb47bffa10623f">CreateXalanTransformer</a> () |
| <dl class="el"><dd class="mdescRight">Create a <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. <a href="#a1b76c8e523232e033ccb47bffa10623f"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a56612158eac82a77c456922ed42e29d5">DeleteXalanTransformer</a> (<a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Delete a <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. <a href="#a56612158eac82a77c456922ed42e29d5"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a7c4c4cb77cd7ea68b460d525b4d06dff">XalanTransformToFile</a> (const char *theXMLFileName, const char *theXSLFileName, const char *theOutFileName, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Transform the XML source tree to the given result file. <a href="#a7c4c4cb77cd7ea68b460d525b4d06dff"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#ae7c74a729d65a17f904b358ba86d5cab">XalanTransformToFilePrebuilt</a> (<a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> theParsedSource, <a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> theCSSHandle, const char *theOutFileName, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Transform the XML source tree to the given result file. <a href="#ae7c74a729d65a17f904b358ba86d5cab"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#ad2cf845c20c6b40ee1d558314a81de32">XalanTransformToData</a> (const char *theXMLFileName, const char *theXSLFileName, char **theOutput, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Transform the XML source tree to a dynamically allocated buffer. <a href="#ad2cf845c20c6b40ee1d558314a81de32"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#af6d4cf26bae0157e8db62093e738c153">XalanTransformToDataPrebuilt</a> (<a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> theParsedSource, <a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> theCSSHandle, char **theOutput, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Transform the XML source tree to a dynamically-allocated buffer. <a href="#af6d4cf26bae0157e8db62093e738c153"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a95ef1a205f372f95d320f53739417653">XalanFreeData</a> (char *theData) |
| <dl class="el"><dd class="mdescRight">Free memory allocated as a result of calling XalanTransformToData. <a href="#a95ef1a205f372f95d320f53739417653"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a933a75a9afd7acd0a2b214f32e456e1f">XalanTransformToHandler</a> (const char *theXMLFileName, const char *theXSLFileName, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle, void *theOutputHandle, <a class="el" href="XalanTransformerDefinitions_8hpp.html#a1dc959aba772c6560c207640b1078029">XalanOutputHandlerType</a> theOutputHandler, <a class="el" href="XalanTransformerDefinitions_8hpp.html#af9c91954b5abd9dde361ad9631c12295">XalanFlushHandlerType</a> theFlushHandler) |
| <dl class="el"><dd class="mdescRight">Transform the XML source tree to a callback function. <a href="#a933a75a9afd7acd0a2b214f32e456e1f"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#ac482ee89db18e04988cf4bab98e810a2">XalanTransformToHandlerPrebuilt</a> (<a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> thePSHandle, <a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> theCSSHandle, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle, void *theOutputHandle, <a class="el" href="XalanTransformerDefinitions_8hpp.html#a1dc959aba772c6560c207640b1078029">XalanOutputHandlerType</a> theOutputHandler, <a class="el" href="XalanTransformerDefinitions_8hpp.html#af9c91954b5abd9dde361ad9631c12295">XalanFlushHandlerType</a> theFlushHandler) |
| <dl class="el"><dd class="mdescRight">Transform the XML source tree to a callback function. <a href="#ac482ee89db18e04988cf4bab98e810a2"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a051cb11b9652d45700d46a07f2dfeb51">XalanCompileStylesheet</a> (const char *theXSLFileName, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle, <a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> *theCSSHandle) |
| <dl class="el"><dd class="mdescRight">Creates a compiled stylesheet. <a href="#a051cb11b9652d45700d46a07f2dfeb51"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a08bd3449f7478e43dd51583a3a772366">XalanCompileStylesheetFromStream</a> (const char *theXSLStream, unsigned long theXSLStreamLength, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle, <a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> *theCSSHandle) |
| <dl class="el"><dd class="mdescRight">Creates a compiled stylesheet. <a href="#a08bd3449f7478e43dd51583a3a772366"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a98dfe2fb92858c5e2890bad39ead5846">XalanDestroyCompiledStylesheet</a> (<a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> theCSSHandle, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Destroys a compiled stylesheet. <a href="#a98dfe2fb92858c5e2890bad39ead5846"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a9a376f062779b8e01bbaad16eaf826b4">XalanParseSource</a> (const char *theXMLFileName, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle, <a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> *thePSHandle) |
| <dl class="el"><dd class="mdescRight">Parse source document. <a href="#a9a376f062779b8e01bbaad16eaf826b4"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a921158b4c679e2e5c97265501a6c17ad">XalanParseSourceFromStream</a> (const char *theXMLStream, unsigned long theXMLStreamLength, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle, <a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> *thePSHandle) |
| <dl class="el"><dd class="mdescRight">Parse source document from a stream. <a href="#a921158b4c679e2e5c97265501a6c17ad"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#aae16c90c96046e7cd69a884a1c2afed4">XalanDestroyParsedSource</a> (<a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> thePSHandle, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Destroys a parsed source. <a href="#aae16c90c96046e7cd69a884a1c2afed4"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#af076f4ff44907f720bbfe859ae763271">XalanSetStylesheetParam</a> (const char *key, const char *expression, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Set a top-level stylesheet parameter. <a href="#af076f4ff44907f720bbfe859ae763271"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#aa60ee15216415715840b74bd6d5e6063">XalanSetStylesheetParamUTF</a> (const <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> *key, const <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> *expression, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Set a top-level stylesheet parameter. <a href="#aa60ee15216415715840b74bd6d5e6063"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#ae8fc1de585cd6e3423436a2b477ac770">XalanSetStylesheetParamNodeset</a> (const char *key, <a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> theNodeset, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Set a top-level stylesheet nodeset parameter. <a href="#ae8fc1de585cd6e3423436a2b477ac770"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#ada229e78cf64b7eec7f52694885d56f9">XalanSetStylesheetParamUTFNodeset</a> (const <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> *key, <a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> theNodeset, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Set a top-level stylesheet nodeset parameter. <a href="#ada229e78cf64b7eec7f52694885d56f9"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a787691fad8298a15deae6886cb4793e8">XalanSetStylesheetParamNumber</a> (const char *key, double theNumber, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Set a top-level stylesheet number parameter. <a href="#a787691fad8298a15deae6886cb4793e8"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a5a5ae13fcb318d75adf17293cf59b066">XalanSetStylesheetParamUTFNumber</a> (const <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> *key, double theNumber, <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Set a top-level stylesheet number parameter. <a href="#a5a5ae13fcb318d75adf17293cf59b066"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#a36008f4ef30719dc1dff4a6507597674">XalanClearStylesheetParams</a> (<a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Clear the top-level stylesheet parameters. <a href="#a36008f4ef30719dc1dff4a6507597674"></a><br/></dl><li><a class="el" href="XalanCAPI_8h.html#ab9ec00bf3fbe6a946e20418a53891755">XalanGetLastError</a> (<a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Returns the last error that occurred as a result of calling transform. <a href="#ab9ec00bf3fbe6a946e20418a53891755"></a><br/></dl></ul> |
| <hr/><h2>Typedef Documentation</h2> |
| <a class="anchor" id="a75c525e2f83732b3dab062d9a733c112"></a><!-- doxytag: member="XalanCAPI.h::XalanCCharPtr" ref="a75c525e2f83732b3dab062d9a733c112" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef const char* <a class="el" href="XalanCAPI_8h.html#a75c525e2f83732b3dab062d9a733c112">XalanCCharPtr</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>This is a typedef to work around limitations with the XALAN_TRANSFORMER_EXPORT_FUNCTION macro. </p> |
| |
| <p>Definition at line <a class="el" href="XalanCAPI_8h_source.html#l00061">61</a> of file <a class="el" href="XalanCAPI_8h_source.html">XalanCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a367a66f86fbd6d3daddc00301f464826"></a><!-- doxytag: member="XalanCAPI.h::XalanCSSHandle" ref="a367a66f86fbd6d3daddc00301f464826" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef const void* <a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Handle used to store the address of Compiled <a class="el" href="classStylesheet.html" title="This class represents the base stylesheet or an "import" stylesheet.">Stylesheet</a> instance. </p> |
| |
| <p>Definition at line <a class="el" href="XalanCAPI_8h_source.html#l00050">50</a> of file <a class="el" href="XalanCAPI_8h_source.html">XalanCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6424447ecce5f073d80d0ace8d02de62"></a><!-- doxytag: member="XalanCAPI.h::XalanHandle" ref="a6424447ecce5f073d80d0ace8d02de62" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef void* <a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>This is a simple C interface for the class <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a>. </p> |
| <p>It's the user's responsibility to call <a class="el" href="XalanCAPI_8h.html#ab76ae2cf99f71186eedd9013065de0f2" title="Initialize Xerces and Xalan.">XalanInitialize()</a> before making any other API calls, and to call <a class="el" href="XalanCAPI_8h.html#aa0260637cdabb76203273d0e399263e2" title="Terminate Xalan and Xerces.">XalanTerminate()</a> when finished with the API.</p> |
| <p>After calling XalanTransformToData or XalanTransformToDataCSS, the user should call XalanFreeData to release the memory allocated by that operation. Handle used to store the address of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </p> |
| |
| <p>Definition at line <a class="el" href="XalanCAPI_8h_source.html#l00045">45</a> of file <a class="el" href="XalanCAPI_8h_source.html">XalanCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4ca803a3e0e455959507c331cac963be"></a><!-- doxytag: member="XalanCAPI.h::XalanPSHandle" ref="a4ca803a3e0e455959507c331cac963be" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef const void* <a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Handle used to store the address of Parsed Source instance. </p> |
| |
| <p>Definition at line <a class="el" href="XalanCAPI_8h_source.html#l00055">55</a> of file <a class="el" href="XalanCAPI_8h_source.html">XalanCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a90a51ed8db9b99c8edfcf14f2ccd9cc8"></a><!-- doxytag: member="XalanCAPI.h::XalanUTF16Char" ref="a90a51ed8db9b99c8edfcf14f2ccd9cc8" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef XMLCh <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>This is a typedef for characters encoded in UTF-16. </p> |
| |
| <p>Definition at line <a class="el" href="XalanCAPI_8h_source.html#l00066">66</a> of file <a class="el" href="XalanCAPI_8h_source.html">XalanCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <hr/><h2>Function Documentation</h2> |
| <a class="anchor" id="a1b76c8e523232e033ccb47bffa10623f"></a><!-- doxytag: member="XalanCAPI.h::CreateXalanTransformer" ref="a1b76c8e523232e033ccb47bffa10623f" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">CreateXalanTransformer </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Create a <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> handle </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a56612158eac82a77c456922ed42e29d5"></a><!-- doxytag: member="XalanCAPI.h::DeleteXalanTransformer" ref="a56612158eac82a77c456922ed42e29d5" args="(XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">DeleteXalanTransformer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Delete a <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> to destroy. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a36008f4ef30719dc1dff4a6507597674"></a><!-- doxytag: member="XalanCAPI.h::XalanClearStylesheetParams" ref="a36008f4ef30719dc1dff4a6507597674" args="(XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanClearStylesheetParams </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Clear the top-level stylesheet parameters. </p> |
| <p>Top-level stylesheet parameters are sticky. When set, they can be used for multiple transformations. Use the XalanClearStylesheetParams function to clear or reset the top-level stylesheet parameters.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a051cb11b9652d45700d46a07f2dfeb51"></a><!-- doxytag: member="XalanCAPI.h::XalanCompileStylesheet" ref="a051cb11b9652d45700d46a07f2dfeb51" args="(const char *theXSLFileName, XalanHandle theXalanHandle, XalanCSSHandle *theCSSHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanCompileStylesheet </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXSLFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> * </td> |
| <td class="paramname"> <em>theCSSHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Creates a compiled stylesheet. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXSLFileName</em> </td><td>The file name of stylesheet source </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theCSSHandle</em> </td><td>a pointer to a XalanCSSHandle </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a08bd3449f7478e43dd51583a3a772366"></a><!-- doxytag: member="XalanCAPI.h::XalanCompileStylesheetFromStream" ref="a08bd3449f7478e43dd51583a3a772366" args="(const char *theXSLStream, unsigned long theXSLStreamLength, XalanHandle theXalanHandle, XalanCSSHandle *theCSSHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanCompileStylesheetFromStream </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXSLStream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">unsigned long </td> |
| <td class="paramname"> <em>theXSLStreamLength</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> * </td> |
| <td class="paramname"> <em>theCSSHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Creates a compiled stylesheet. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXSLFileName</em> </td><td>The stream that contains the stylesheet xml </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXSLStreamLength</em> </td><td>The length of the stream. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theCSSHandle</em> </td><td>a pointer to a XalanCSSHandle </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a98dfe2fb92858c5e2890bad39ead5846"></a><!-- doxytag: member="XalanCAPI.h::XalanDestroyCompiledStylesheet" ref="a98dfe2fb92858c5e2890bad39ead5846" args="(XalanCSSHandle theCSSHandle, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanDestroyCompiledStylesheet </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> </td> |
| <td class="paramname"> <em>theCSSHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Destroys a compiled stylesheet. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theCSSHandle</em> </td><td>The handle of the compiled stylesheet. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aae16c90c96046e7cd69a884a1c2afed4"></a><!-- doxytag: member="XalanCAPI.h::XalanDestroyParsedSource" ref="aae16c90c96046e7cd69a884a1c2afed4" args="(XalanPSHandle thePSHandle, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanDestroyParsedSource </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> </td> |
| <td class="paramname"> <em>thePSHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Destroys a parsed source. </p> |
| <p>a file name, a stream or a root node.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>thePSHandle</em> </td><td>The handle of parsed source </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a95ef1a205f372f95d320f53739417653"></a><!-- doxytag: member="XalanCAPI.h::XalanFreeData" ref="a95ef1a205f372f95d320f53739417653" args="(char *theData)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanFreeData </td> |
| <td>(</td> |
| <td class="paramtype">char * </td> |
| <td class="paramname"> <em>theData</em></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Free memory allocated as a result of calling XalanTransformToData. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theData</em> </td><td>The address of character data. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab9ec00bf3fbe6a946e20418a53891755"></a><!-- doxytag: member="XalanCAPI.h::XalanGetLastError" ref="ab9ec00bf3fbe6a946e20418a53891755" args="(XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanGetLastError </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Returns the last error that occurred as a result of calling transform. </p> |
| <p>The signature for following function is really: const char* XalanGetLastError(XalanHandle theXalanHandle) const;</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>error message const character pointer. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab76ae2cf99f71186eedd9013065de0f2"></a><!-- doxytag: member="XalanCAPI.h::XalanInitialize" ref="ab76ae2cf99f71186eedd9013065de0f2" args="(void)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanInitialize </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Initialize Xerces and Xalan. </p> |
| <p>Should be called only once per process before making any other API calls.</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, -1 if initialization fails. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9a376f062779b8e01bbaad16eaf826b4"></a><!-- doxytag: member="XalanCAPI.h::XalanParseSource" ref="a9a376f062779b8e01bbaad16eaf826b4" args="(const char *theXMLFileName, XalanHandle theXalanHandle, XalanPSHandle *thePSHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanParseSource </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXMLFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> * </td> |
| <td class="paramname"> <em>thePSHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Parse source document. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXMLFileName</em> </td><td>The name of the file containing the source document </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>thePSHandle</em> </td><td>A pointer to a XalanPSHandle </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a921158b4c679e2e5c97265501a6c17ad"></a><!-- doxytag: member="XalanCAPI.h::XalanParseSourceFromStream" ref="a921158b4c679e2e5c97265501a6c17ad" args="(const char *theXMLStream, unsigned long theXMLStreamLength, XalanHandle theXalanHandle, XalanPSHandle *thePSHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanParseSourceFromStream </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXMLStream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">unsigned long </td> |
| <td class="paramname"> <em>theXMLStreamLength</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> * </td> |
| <td class="paramname"> <em>thePSHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Parse source document from a stream. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXMLStream</em> </td><td>The stream that contains the source xml </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXSLStreamLength</em> </td><td>The length of the stream </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>thePSHandle</em> </td><td>A pointer to a XalanPSHandle </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af076f4ff44907f720bbfe859ae763271"></a><!-- doxytag: member="XalanCAPI.h::XalanSetStylesheetParam" ref="af076f4ff44907f720bbfe859ae763271" args="(const char *key, const char *expression, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanSetStylesheetParam </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>expression</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Set a top-level stylesheet parameter. </p> |
| <p>This value can be evaluated via xsl:param-variable.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The name of the param </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>expression</em> </td><td>The expression that will be evaluated </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae8fc1de585cd6e3423436a2b477ac770"></a><!-- doxytag: member="XalanCAPI.h::XalanSetStylesheetParamNodeset" ref="ae8fc1de585cd6e3423436a2b477ac770" args="(const char *key, XalanPSHandle theNodeset, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanSetStylesheetParamNodeset </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> </td> |
| <td class="paramname"> <em>theNodeset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Set a top-level stylesheet nodeset parameter. </p> |
| <p>This value can be evaluated via xsl:param-variable. The value is a parsed document.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>name of the param </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theNodeset</em> </td><td>a preparsed document </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a787691fad8298a15deae6886cb4793e8"></a><!-- doxytag: member="XalanCAPI.h::XalanSetStylesheetParamNumber" ref="a787691fad8298a15deae6886cb4793e8" args="(const char *key, double theNumber, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanSetStylesheetParamNumber </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">double </td> |
| <td class="paramname"> <em>theNumber</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Set a top-level stylesheet number parameter. </p> |
| <p>This value can be evaluated via xsl:param-variable. The value is a parsed document.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>name of the param </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theNumber</em> </td><td>a double floating point number </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa60ee15216415715840b74bd6d5e6063"></a><!-- doxytag: member="XalanCAPI.h::XalanSetStylesheetParamUTF" ref="aa60ee15216415715840b74bd6d5e6063" args="(const XalanUTF16Char *key, const XalanUTF16Char *expression, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanSetStylesheetParamUTF </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> * </td> |
| <td class="paramname"> <em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> * </td> |
| <td class="paramname"> <em>expression</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Set a top-level stylesheet parameter. </p> |
| <p>This value can be evaluated via xsl:param-variable. The key and expression parameters must be encoded in UTF-16.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>name of the param </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>expression</em> </td><td>expression that will be evaluated </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ada229e78cf64b7eec7f52694885d56f9"></a><!-- doxytag: member="XalanCAPI.h::XalanSetStylesheetParamUTFNodeset" ref="ada229e78cf64b7eec7f52694885d56f9" args="(const XalanUTF16Char *key, XalanPSHandle theNodeset, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanSetStylesheetParamUTFNodeset </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> * </td> |
| <td class="paramname"> <em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> </td> |
| <td class="paramname"> <em>theNodeset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Set a top-level stylesheet nodeset parameter. </p> |
| <p>This value can be evaluated via xsl:param-variable. The value is a parsed document. The key name is a UTF-16 string.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>name of the param </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theNodeset</em> </td><td>a preparsed document </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5a5ae13fcb318d75adf17293cf59b066"></a><!-- doxytag: member="XalanCAPI.h::XalanSetStylesheetParamUTFNumber" ref="a5a5ae13fcb318d75adf17293cf59b066" args="(const XalanUTF16Char *key, double theNumber, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanSetStylesheetParamUTFNumber </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="XalanCAPI_8h.html#a90a51ed8db9b99c8edfcf14f2ccd9cc8">XalanUTF16Char</a> * </td> |
| <td class="paramname"> <em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">double </td> |
| <td class="paramname"> <em>theNumber</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Set a top-level stylesheet number parameter. </p> |
| <p>This value can be evaluated via xsl:param-variable. The value is a parsed document. The key name is a UTF-16 string.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>name of the param </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theNumber</em> </td><td>a double floating point number </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa0260637cdabb76203273d0e399263e2"></a><!-- doxytag: member="XalanCAPI.h::XalanTerminate" ref="aa0260637cdabb76203273d0e399263e2" args="(int fCleanUpICU)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanTerminate </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"> <em>fCleanUpICU</em></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Terminate Xalan and Xerces. </p> |
| <p>Should be called only once per process after deleting all instances of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a>.</p> |
| <p>Once a process has called this function, it cannot use the API until another call to XalanInitialize has been made.</p> |
| <p>Optionally, if the ICU has been integrated, this will call the ICU clean up function. This must only be done if the ICU will no longer be used by the process, since the ICU will no longer be in a usable state. See the ICU documentation for more details.</p> |
| <p>This is handy when using leak-detection software, as all static data allocated by Xalan (and optionally, the ICU) will be freed.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>fCleanUpICU</em> </td><td>If true, call the ICU clean up function. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad2cf845c20c6b40ee1d558314a81de32"></a><!-- doxytag: member="XalanCAPI.h::XalanTransformToData" ref="ad2cf845c20c6b40ee1d558314a81de32" args="(const char *theXMLFileName, const char *theXSLFileName, char **theOutput, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanTransformToData </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXMLFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXSLFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char ** </td> |
| <td class="paramname"> <em>theOutput</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Transform the XML source tree to a dynamically allocated buffer. </p> |
| <p>The processor will apply the stylesheet file to the input file and assign the address of the dynamically allocated result to a user-supplied pointer. The user must call XalanFreeData with this pointer to free the memory.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXMLFileName</em> </td><td>The file name of the XML document. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXSLFileName</em> </td><td>The file name of the stylesheet XML document. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theOutput</em> </td><td>a pointer to a char* </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af6d4cf26bae0157e8db62093e738c153"></a><!-- doxytag: member="XalanCAPI.h::XalanTransformToDataPrebuilt" ref="af6d4cf26bae0157e8db62093e738c153" args="(XalanPSHandle theParsedSource, XalanCSSHandle theCSSHandle, char **theOutput, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanTransformToDataPrebuilt </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> </td> |
| <td class="paramname"> <em>theParsedSource</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> </td> |
| <td class="paramname"> <em>theCSSHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char ** </td> |
| <td class="paramname"> <em>theOutput</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Transform the XML source tree to a dynamically-allocated buffer. </p> |
| <p>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 this pointer to free the memory.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theParsedSource</em> </td><td>The handle of a parsed source </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theCSSHandle</em> </td><td>The handle of compiled stylesheet </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theOutput</em> </td><td>a pointer to a char* </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7c4c4cb77cd7ea68b460d525b4d06dff"></a><!-- doxytag: member="XalanCAPI.h::XalanTransformToFile" ref="a7c4c4cb77cd7ea68b460d525b4d06dff" args="(const char *theXMLFileName, const char *theXSLFileName, const char *theOutFileName, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanTransformToFile </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXMLFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXSLFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theOutFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Transform the XML source tree to the given result file. </p> |
| <p>The processor will apply the stylesheet file to the input file and write the transformation result to a new output file.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXMLFileName</em> </td><td>The file name of the XML document. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXSLFileName</em> </td><td>The file name of the stylesheet XML document. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theOutFileName</em> </td><td>The file name for the output. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of a <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae7c74a729d65a17f904b358ba86d5cab"></a><!-- doxytag: member="XalanCAPI.h::XalanTransformToFilePrebuilt" ref="ae7c74a729d65a17f904b358ba86d5cab" args="(XalanPSHandle theParsedSource, XalanCSSHandle theCSSHandle, const char *theOutFileName, XalanHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanTransformToFilePrebuilt </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> </td> |
| <td class="paramname"> <em>theParsedSource</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> </td> |
| <td class="paramname"> <em>theCSSHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theOutFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Transform the XML source tree to the given result file. </p> |
| <p>The processor will apply the compiled stylesheet to the input file and write the transformation result to a new output file.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theParsedSource</em> </td><td>The handle of a parsed source </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theCSSHandle</em> </td><td>The handle of a compiled stylesheet </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theOutFileName</em> </td><td>The file name for the output. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of a <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a933a75a9afd7acd0a2b214f32e456e1f"></a><!-- doxytag: member="XalanCAPI.h::XalanTransformToHandler" ref="a933a75a9afd7acd0a2b214f32e456e1f" args="(const char *theXMLFileName, const char *theXSLFileName, XalanHandle theXalanHandle, void *theOutputHandle, XalanOutputHandlerType theOutputHandler, XalanFlushHandlerType theFlushHandler)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanTransformToHandler </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXMLFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXSLFileName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"> <em>theOutputHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanTransformerDefinitions_8hpp.html#a1dc959aba772c6560c207640b1078029">XalanOutputHandlerType</a> </td> |
| <td class="paramname"> <em>theOutputHandler</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanTransformerDefinitions_8hpp.html#af9c91954b5abd9dde361ad9631c12295">XalanFlushHandlerType</a> </td> |
| <td class="paramname"> <em>theFlushHandler</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Transform the XML source tree to a callback function. </p> |
| <p>The processor will apply the stylesheet file to the input file and allocate the transformation result to a callback function in pre-allocated blocks. Once the transformation is complete, a second callback, to flush the buffer, is called. You can pass in NULL if you do not wish to implement a flush callback. Xalan will release any memory allocated upon termination, and data passed to the callback is not guaranteed to be null terminated.</p> |
| <p>See <a class="el" href="XalanTransformerDefinitions_8hpp.html">XalanTransformerDefinitions.hpp</a> for more details.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXMLFileName</em> </td><td>The file name of XML input source </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXSLFileName</em> </td><td>The file name of stylesheet source </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of a <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theOutputHandle</em> </td><td>A void pointer passed through to callback. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theOutputHandler</em> </td><td>A user-defined callback function pointer. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theFlushHandler</em> </td><td>A user-defined callback function pointer, which can be null. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac482ee89db18e04988cf4bab98e810a2"></a><!-- doxytag: member="XalanCAPI.h::XalanTransformToHandlerPrebuilt" ref="ac482ee89db18e04988cf4bab98e810a2" args="(XalanPSHandle thePSHandle, XalanCSSHandle theCSSHandle, XalanHandle theXalanHandle, void *theOutputHandle, XalanOutputHandlerType theOutputHandler, XalanFlushHandlerType theFlushHandler)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanTransformToHandlerPrebuilt </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a4ca803a3e0e455959507c331cac963be">XalanPSHandle</a> </td> |
| <td class="paramname"> <em>thePSHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a367a66f86fbd6d3daddc00301f464826">XalanCSSHandle</a> </td> |
| <td class="paramname"> <em>theCSSHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanCAPI_8h.html#a6424447ecce5f073d80d0ace8d02de62">XalanHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"> <em>theOutputHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanTransformerDefinitions_8hpp.html#a1dc959aba772c6560c207640b1078029">XalanOutputHandlerType</a> </td> |
| <td class="paramname"> <em>theOutputHandler</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XalanTransformerDefinitions_8hpp.html#af9c91954b5abd9dde361ad9631c12295">XalanFlushHandlerType</a> </td> |
| <td class="paramname"> <em>theFlushHandler</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Transform the XML source tree to a callback function. </p> |
| <p>The processor will apply the compiled stylesheet to the input file and allocate the transformation result to a callback function in pre-allocated blocks. Once the transformation is complete, a second callback, to flush the buffer, is called. You can pass in NULL if you do not wish to implement a flush callback. Xalan will release any memory allocated upon termination, and data passed to the callback is not guaranteed to be null terminated.</p> |
| <p>See <a class="el" href="XalanTransformerDefinitions_8hpp.html">XalanTransformerDefinitions.hpp</a> for more details.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>thePSHandle</em> </td><td>The handle of parsed source </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theCSSHandle</em> </td><td>The handle of compiled stylesheet </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theOutputHandle</em> </td><td>A void pointer passed through to callback. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theOutputHandler</em> </td><td>A user-defined callback function pointer. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theFlushHandler</em> </td><td>A user-defined callback function pointer, which can be null. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success </dd></dl> |
| |
| </div> |
| </div> |
| </div> |
| <p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p> |
| <p><font color="#000000" face="arial,helvetica,sanserif" size="-1"> |
| <i><a href="http://www.doxygen.org/">Doxygen</a> and |
| <a href="http://www.graphviz.org/">GraphViz</a> are |
| used to generate this API documentation from the Xalan-C header files.</i></font></p> |
| |
| <table border="0" cellpadding="0" cellspacing="0" width="80%"> |
| <tr> |
| <td width="80%" valign="top"> |
| <p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/> |
| Copyright © 1999-2012 The Apache Software Foundation.<br/> |
| All Rights Reserved.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="100%"> |
| <p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo"> |
| </td> |
| </tr> |
| </table> |
| </body> |
| </html> |
