| <!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 class="header"> |
| <div class="headertitle"> |
| <h1>XalanFileOutputStream.hpp</h1> </div> |
| </div> |
| <div class="contents"> |
| <a href="XalanFileOutputStream_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> |
| <a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <a name="l00003"></a>00003 <span class="comment"> * or more contributor license agreements. See the NOTICE file</span> |
| <a name="l00004"></a>00004 <span class="comment"> * distributed with this work for additional information</span> |
| <a name="l00005"></a>00005 <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span> |
| <a name="l00006"></a>00006 <span class="comment"> * to you under the Apache License, Version 2.0 (the "License");</span> |
| <a name="l00007"></a>00007 <span class="comment"> * you may not use this file except in compliance with the License.</span> |
| <a name="l00008"></a>00008 <span class="comment"> * You may obtain a copy of the License at</span> |
| <a name="l00009"></a>00009 <span class="comment"> *</span> |
| <a name="l00010"></a>00010 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <a name="l00011"></a>00011 <span class="comment"> *</span> |
| <a name="l00012"></a>00012 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> |
| <a name="l00013"></a>00013 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <a name="l00014"></a>00014 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <a name="l00015"></a>00015 <span class="comment"> * See the License for the specific language governing permissions and</span> |
| <a name="l00016"></a>00016 <span class="comment"> * limitations under the License.</span> |
| <a name="l00017"></a>00017 <span class="comment"> */</span> |
| <a name="l00018"></a>00018 <span class="preprocessor">#if !defined(XALANFILEOUTPUTSTREAM_HEADER_GUARD_1357924680)</span> |
| <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALANFILEOUTPUTSTREAM_HEADER_GUARD_1357924680</span> |
| <a name="l00020"></a>00020 <span class="preprocessor"></span> |
| <a name="l00021"></a>00021 |
| <a name="l00022"></a>00022 |
| <a name="l00023"></a>00023 <span class="comment">// Base include file. Must be first.</span> |
| <a name="l00024"></a>00024 <span class="preprocessor">#include <<a class="code" href="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>></span> |
| <a name="l00025"></a>00025 |
| <a name="l00026"></a>00026 |
| <a name="l00027"></a>00027 |
| <a name="l00028"></a>00028 <span class="preprocessor">#if defined(XALAN_WINDOWS)</span> |
| <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include <windows.h></span> |
| <a name="l00030"></a>00030 <span class="preprocessor">#else</span> |
| <a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#include <cstdio></span> |
| <a name="l00032"></a>00032 <span class="preprocessor">#endif</span> |
| <a name="l00033"></a>00033 <span class="preprocessor"></span> |
| <a name="l00034"></a>00034 |
| <a name="l00035"></a>00035 |
| <a name="l00036"></a>00036 <span class="comment">// Base class header file.</span> |
| <a name="l00037"></a>00037 <span class="preprocessor">#include <<a class="code" href="XalanOutputStream_8hpp.html">xalanc/PlatformSupport/XalanOutputStream.hpp</a>></span> |
| <a name="l00038"></a>00038 |
| <a name="l00039"></a>00039 |
| <a name="l00040"></a>00040 |
| <a name="l00041"></a>00041 XALAN_CPP_NAMESPACE_BEGIN |
| <a name="l00042"></a>00042 |
| <a name="l00043"></a>00043 |
| <a name="l00044"></a>00044 <span class="preprocessor">#if defined(XALAN_STRICT_ANSI_HEADERS)</span> |
| <a name="l00045"></a>00045 <span class="preprocessor"></span><span class="keyword">using</span> std::FILE; |
| <a name="l00046"></a>00046 <span class="preprocessor">#endif</span> |
| <a name="l00047"></a>00047 <span class="preprocessor"></span> |
| <a name="l00048"></a><a class="code" href="classXalanFileOutputStream.html">00048</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a> |
| <a name="l00049"></a>00049 { |
| <a name="l00050"></a>00050 <span class="keyword">public</span> : |
| <a name="l00051"></a>00051 |
| <a name="l00052"></a><a class="code" href="classXalanFileOutputStream.html#a3c4baf9cb19928803197cc10a0a2b553a581eb99739cd7a8142ae70207574cb54">00052</a> <span class="keyword">enum</span> { eDefaultBufferSize = 8192u }; |
| <a name="l00053"></a>00053 |
| <a name="l00054"></a>00054 <span class="preprocessor">#if defined(XALAN_WINDOWS)</span> |
| <a name="l00055"></a>00055 <span class="preprocessor"></span> <span class="keyword">typedef</span> HANDLE HandleType; |
| <a name="l00056"></a>00056 <span class="preprocessor">#else</span> |
| <a name="l00057"></a><a class="code" href="classXalanFileOutputStream.html#a93d6fd4d0339c4473b1f29eb61d14d28">00057</a> <span class="preprocessor"></span> <span class="keyword">typedef</span> FILE* HandleType; |
| <a name="l00058"></a>00058 <span class="preprocessor">#endif</span> |
| <a name="l00059"></a>00059 <span class="preprocessor"></span><span class="comment"></span> |
| <a name="l00060"></a>00060 <span class="comment"> /**</span> |
| <a name="l00061"></a>00061 <span class="comment"> * Construct an XalanFileOutputStream object.</span> |
| <a name="l00062"></a>00062 <span class="comment"> * </span> |
| <a name="l00063"></a>00063 <span class="comment"> * @param theFileName name of file</span> |
| <a name="l00064"></a>00064 <span class="comment"> * @param theBufferSize The size of the transcoding buffer</span> |
| <a name="l00065"></a>00065 <span class="comment"> */</span> |
| <a name="l00066"></a>00066 <a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a>( |
| <a name="l00067"></a>00067 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& theFileName, |
| <a name="l00068"></a>00068 MemoryManager& theManager, |
| <a name="l00069"></a>00069 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferSize = eDefaultBufferSize); |
| <a name="l00070"></a>00070 |
| <a name="l00071"></a>00071 <span class="keyword">static</span> <a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a>* |
| <a name="l00072"></a>00072 create( |
| <a name="l00073"></a>00073 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& theFileName, |
| <a name="l00074"></a>00074 MemoryManager& theManager, |
| <a name="l00075"></a>00075 <a class="code" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferSize = eDefaultBufferSize); |
| <a name="l00076"></a>00076 <span class="keyword">virtual</span> |
| <a name="l00077"></a>00077 ~<a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a>(); |
| <a name="l00078"></a>00078 |
| <a name="l00079"></a>00079 |
| <a name="l00080"></a><a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamOpenException.html">00080</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamOpenException.html">XalanFileOutputStreamOpenException</a> : <span class="keyword">public</span> <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>::<a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a> |
| <a name="l00081"></a>00081 { |
| <a name="l00082"></a>00082 <span class="keyword">public</span>: |
| <a name="l00083"></a>00083 <span class="comment"></span> |
| <a name="l00084"></a>00084 <span class="comment"> /**</span> |
| <a name="l00085"></a>00085 <span class="comment"> * Construct an XalanFileOutputStreamOpen exception object for an exception</span> |
| <a name="l00086"></a>00086 <span class="comment"> * that occurred on opening a text file stream.</span> |
| <a name="l00087"></a>00087 <span class="comment"> * </span> |
| <a name="l00088"></a>00088 <span class="comment"> * @param theFileName name of file causing the exception</span> |
| <a name="l00089"></a>00089 <span class="comment"> * @param theErrorCode number of error encountered</span> |
| <a name="l00090"></a>00090 <span class="comment"> */</span> |
| <a name="l00091"></a>00091 <a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamOpenException.html">XalanFileOutputStreamOpenException</a>( |
| <a name="l00092"></a>00092 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& theFileName, |
| <a name="l00093"></a>00093 <span class="keywordtype">int</span> theErrorCode, |
| <a name="l00094"></a>00094 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& theBuffer, |
| <a name="l00095"></a>00095 <span class="keyword">const</span> Locator* theLocator = 0); |
| <a name="l00096"></a>00096 |
| <a name="l00097"></a>00097 <span class="keyword">virtual</span> |
| <a name="l00098"></a>00098 ~<a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamOpenException.html">XalanFileOutputStreamOpenException</a>(); |
| <a name="l00099"></a>00099 |
| <a name="l00100"></a>00100 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMChar* |
| <a name="l00101"></a><a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamOpenException.html#addb2f4e5ad2de5400e0bcd64592ff772">00101</a> getType()<span class="keyword"> const</span> |
| <a name="l00102"></a>00102 <span class="keyword"> </span>{ |
| <a name="l00103"></a>00103 <span class="keywordflow">return</span> m_type; |
| <a name="l00104"></a>00104 } |
| <a name="l00105"></a>00105 |
| <a name="l00106"></a>00106 <span class="keyword">private</span>: |
| <a name="l00107"></a>00107 |
| <a name="l00108"></a>00108 <span class="keyword">static</span> <span class="keyword">const</span> XalanDOMChar m_type[]; |
| <a name="l00109"></a>00109 |
| <a name="l00110"></a>00110 }; |
| <a name="l00111"></a>00111 |
| <a name="l00112"></a><a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamWriteException.html">00112</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamWriteException.html">XalanFileOutputStreamWriteException</a> : <span class="keyword">public</span> <a class="code" href="classXalanOutputStream.html">XalanOutputStream</a>::<a class="code" href="classXalanOutputStream_1_1XalanOutputStreamException.html">XalanOutputStreamException</a> |
| <a name="l00113"></a>00113 { |
| <a name="l00114"></a>00114 <span class="keyword">public</span>: |
| <a name="l00115"></a>00115 <span class="comment"></span> |
| <a name="l00116"></a>00116 <span class="comment"> /**</span> |
| <a name="l00117"></a>00117 <span class="comment"> * Construct an XalanFileOutputStreamOpen exception object for an exception</span> |
| <a name="l00118"></a>00118 <span class="comment"> * that occurred while writing to a text file stream.</span> |
| <a name="l00119"></a>00119 <span class="comment"> * </span> |
| <a name="l00120"></a>00120 <span class="comment"> * @param theFileName name of file causing the exception</span> |
| <a name="l00121"></a>00121 <span class="comment"> * @param theErrorCode number of error encountered</span> |
| <a name="l00122"></a>00122 <span class="comment"> */</span> |
| <a name="l00123"></a>00123 <a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamWriteException.html">XalanFileOutputStreamWriteException</a>( |
| <a name="l00124"></a>00124 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& theFileName, |
| <a name="l00125"></a>00125 <span class="keywordtype">int</span> theErrorCode, |
| <a name="l00126"></a>00126 <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& theBuffer, |
| <a name="l00127"></a>00127 <span class="keyword">const</span> Locator* theLocator = 0); |
| <a name="l00128"></a>00128 |
| <a name="l00129"></a>00129 <span class="keyword">virtual</span> |
| <a name="l00130"></a>00130 ~<a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamWriteException.html">XalanFileOutputStreamWriteException</a>(); |
| <a name="l00131"></a>00131 |
| <a name="l00132"></a>00132 <span class="keyword">virtual</span> <span class="keyword">const</span> XalanDOMChar* |
| <a name="l00133"></a><a class="code" href="classXalanFileOutputStream_1_1XalanFileOutputStreamWriteException.html#a8b0798eaff495b07704abbe793f76395">00133</a> getType()<span class="keyword"> const</span> |
| <a name="l00134"></a>00134 <span class="keyword"> </span>{ |
| <a name="l00135"></a>00135 <span class="keywordflow">return</span> m_type; |
| <a name="l00136"></a>00136 } |
| <a name="l00137"></a>00137 |
| <a name="l00138"></a>00138 <span class="keyword">private</span>: |
| <a name="l00139"></a>00139 <span class="keyword">static</span> <span class="keyword">const</span> XalanDOMChar m_type[]; |
| <a name="l00140"></a>00140 |
| <a name="l00141"></a>00141 }; |
| <a name="l00142"></a>00142 |
| <a name="l00143"></a>00143 <span class="keyword">protected</span>: |
| <a name="l00144"></a>00144 |
| <a name="l00145"></a>00145 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00146"></a>00146 <a class="code" href="classXalanOutputStream.html#afd3ee66f24a4a20803546ffcd7092304" title="Write the data in the buffer.">writeData</a>( |
| <a name="l00147"></a>00147 <span class="keyword">const</span> <span class="keywordtype">char</span>* theBuffer, |
| <a name="l00148"></a>00148 <a class="code" href="XalanMap_8hpp.html#a39efc23c4f36ef6389e4a1fbe96c5f2e">size_type</a> theBufferLength); |
| <a name="l00149"></a>00149 |
| <a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00151"></a>00151 <a class="code" href="classXalanOutputStream.html#af877c1e7589acbd180dbb112dc1512d1" title="Flush the stream.">doFlush</a>(); |
| <a name="l00152"></a>00152 |
| <a name="l00153"></a>00153 <span class="keyword">private</span>: |
| <a name="l00154"></a>00154 |
| <a name="l00155"></a>00155 <span class="comment">// These are not implemented...</span> |
| <a name="l00156"></a>00156 <a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a>(<span class="keyword">const</span> <a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a>&); |
| <a name="l00157"></a>00157 |
| <a name="l00158"></a>00158 <a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a>& |
| <a name="l00159"></a>00159 operator=(<span class="keyword">const</span> <a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a>&); |
| <a name="l00160"></a>00160 |
| <a name="l00161"></a>00161 <span class="keywordtype">bool</span> |
| <a name="l00162"></a>00162 <a class="code" href="ElemAttributeSet_8hpp.html#ae199bc16afddda1065706543e752d292">operator==</a>(<span class="keyword">const</span> <a class="code" href="classXalanFileOutputStream.html">XalanFileOutputStream</a>&) <span class="keyword">const</span>; |
| <a name="l00163"></a>00163 |
| <a name="l00164"></a>00164 |
| <a name="l00165"></a>00165 <span class="comment">// Data members...</span> |
| <a name="l00166"></a>00166 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> m_fileName; |
| <a name="l00167"></a>00167 |
| <a name="l00168"></a>00168 <span class="keyword">const</span> HandleType m_handle; |
| <a name="l00169"></a>00169 }; |
| <a name="l00170"></a>00170 |
| <a name="l00171"></a>00171 |
| <a name="l00172"></a>00172 |
| <a name="l00173"></a>00173 XALAN_CPP_NAMESPACE_END |
| <a name="l00174"></a>00174 |
| <a name="l00175"></a>00175 |
| <a name="l00176"></a>00176 |
| <a name="l00177"></a>00177 <span class="preprocessor">#endif // XALANFILEOUTPUTSTREAM_HEADER_GUARD_1357924680</span> |
| </pre></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> |
