group__g__file.html

ORACLE编程的好东西,纯C写的OCI封装.很好用,支持数据池.

Create a file object instance. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>con</em>&nbsp;</td><td>- Connection handle </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>- File type</td></tr>
  </table>
</dl>
Supported file types :<p>
<ul>
<li>OCI_BFILE : Binary file</li><li>OCI_CFILE : Character file</li></ul>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return the lob handle on success otherwise NULL on failure </dd></dl>

<p>Definition at line <a class="el" href="file_8c-source.html#l00190">190</a> of file <a class="el" href="file_8c-source.html">file.c</a>.</p>

</div>
</div><p>
<a class="anchor" name="g634da122ca768f1c219ed08a113da0d3"></a><!-- doxytag: member="ocilib.h::OCI_FileExists" ref="g634da122ca768f1c219ed08a113da0d3" args="(OCI_File *file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OCI_EXPORT boolean OCI_API OCI_FileExists           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if the given file exists on server. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>- File handle</td></tr>
  </table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>for local FILEs object, OCI_LobFileSetName() must be called before to set the filename to check</dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE on success otherwise FALSE </dd></dl>

<p>Definition at line <a class="el" href="file_8c-source.html#l00397">397</a> of file <a class="el" href="file_8c-source.html">file.c</a>.</p>

<p>References <a class="el" href="ocilib__types_8h-source.html#l00418">OCI_File::con</a>, <a class="el" href="ocilib__types_8h-source.html#l00237">OCI_Connection::cxt</a>, <a class="el" href="ocilib__types_8h-source.html#l00235">OCI_Connection::err</a>, and <a class="el" href="ocilib__types_8h-source.html#l00416">OCI_File::handle</a>.</p>

</div>
</div><p>
<a class="anchor" name="gd4b58b6d80e24bb045fb82d78c5cf36a"></a><!-- doxytag: member="ocilib.h::OCI_FileFree" ref="gd4b58b6d80e24bb045fb82d78c5cf36a" args="(OCI_File *file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OCI_EXPORT boolean OCI_API OCI_FileFree           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Free a local File object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>- File handle</td></tr>
  </table>
</dl>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>Only Files created with <a class="el" href="group__g__file.html#g199d6ce1a1231feb56b456ad6cbc2714" title="Create a file object instance.">OCI_FileCreate()</a> should be freed by <a class="el" href="group__g__file.html#gd4b58b6d80e24bb045fb82d78c5cf36a" title="Free a local File object.">OCI_FileFree()</a></dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE on success otherwise FALSE </dd></dl>

<p>Definition at line <a class="el" href="file_8c-source.html#l00209">209</a> of file <a class="el" href="file_8c-source.html">file.c</a>.</p>

<p>References <a class="el" href="ocilib__types_8h-source.html#l00419">OCI_File::dir</a>, <a class="el" href="ocilib__types_8h-source.html#l00416">OCI_File::handle</a>, <a class="el" href="ocilib__types_8h-source.html#l00417">OCI_File::hstate</a>, and <a class="el" href="ocilib__types_8h-source.html#l00420">OCI_File::name</a>.</p>

<p>Referenced by <a class="el" href="group__g__collection.html#gdf1010d812aa53c3b27d991fa47b4f98">OCI_ElemFree()</a>, and <a class="el" href="group__g__usertypes.html#g3fd2c9dfdcab2c56400c95c31cc0851e">OCI_ObjectFree()</a>.</p>

</div>
</div><p>
<a class="anchor" name="g920ae6408404696e2c76cfc73a568136"></a><!-- doxytag: member="ocilib.h::OCI_FileGetDirectory" ref="g920ae6408404696e2c76cfc73a568136" args="(OCI_File *file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OCI_EXPORT const mtext* OCI_API OCI_FileGetDirectory           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the directory of the given file. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>- File handle </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="file_8c-source.html#l00459">459</a> of file <a class="el" href="file_8c-source.html">file.c</a>.</p>

<p>References <a class="el" href="ocilib__types_8h-source.html#l00419">OCI_File::dir</a>.</p>

</div>
</div><p>
<a class="anchor" name="gc2e9e12274b96e406fcbe59203338d2c"></a><!-- doxytag: member="ocilib.h::OCI_FileGetName" ref="gc2e9e12274b96e406fcbe59203338d2c" args="(OCI_File *file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OCI_EXPORT const mtext* OCI_API OCI_FileGetName           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the name of the given file. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>- File handle </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="file_8c-source.html#l00476">476</a> of file <a class="el" href="file_8c-source.html">file.c</a>.</p>

<p>References <a class="el" href="ocilib__types_8h-source.html#l00420">OCI_File::name</a>.</p>

</div>
</div><p>
<a class="anchor" name="g7032e262e260dd6f50515058b722f951"></a><!-- doxytag: member="ocilib.h::OCI_FileGetOffset" ref="g7032e262e260dd6f50515058b722f951" args="(OCI_File *file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OCI_EXPORT big_uint OCI_API OCI_FileGetOffset           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the current position in the file. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>- File handle</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>File position (starting with 0) or 0 on failure </dd></dl>

<p>Definition at line <a class="el" href="file_8c-source.html#l00264">264</a> of file <a class="el" href="file_8c-source.html">file.c</a>.</p>

<p>References <a class="el" href="ocilib__types_8h-source.html#l00422">OCI_File::offset</a>.</p>

</div>
</div><p>
<a class="anchor" name="g0cf778c46524cb185d2d60e1cac672f5"></a><!-- doxytag: member="ocilib.h::OCI_FileGetSize" ref="g0cf778c46524cb185d2d60e1cac672f5" args="(OCI_File *file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OCI_EXPORT big_uint OCI_API OCI_FileGetSize           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the size in bytes of a file. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>- File handle </td></tr>
  </table>
</dl>

<p>Definition at line <a class="el" href="file_8c-source.html#l00350">350</a> of file <a class="el" href="file_8c-source.html">file.c</a>.</p>

<p>References <a class="el" href="ocilib__types_8h-source.html#l00418">OCI_File::con</a>, <a class="el" href="ocilib__types_8h-source.html#l00237">OCI_Connection::cxt</a>, <a class="el" href="ocilib__types_8h-source.html#l00235">OCI_Connection::err</a>, and <a class="el" href="ocilib__types_8h-source.html#l00416">OCI_File::handle</a>.</p>

<p>Referenced by <a class="el" href="group__g__file.html#gfb3e54d66132f999c576adf15fdd581e">OCI_FileSeek()</a>.</p>

</div>
</div><p>
<a class="anchor" name="gaab496da783753ec077afcc03cde0770"></a><!-- doxytag: member="ocilib.h::OCI_FileGetType" ref="gaab496da783753ec077afcc03cde0770" args="(OCI_File *file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OCI_EXPORT unsigned int OCI_API OCI_FileGetType           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the type of the given File object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>file</em>&nbsp;</td><td>- File handle</td></tr>
  </table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>For possibles values, see <a class="el" href="group__g__file.html#g199d6ce1a1231feb56b456ad6cbc2714" title="Create a file object instance.">OCI_FileCreate()</a></dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Object type or OCI_UNKNOWN the input handle is NULL </dd></dl>

<p>Definition at line <a class="el" href="file_8c-source.html#l00337">337</a> of file <a class="el" href="file_8c-source.html">file.c</a>.</p>

<p>References <a class="el" href="ocilib__types_8h-source.html#l00421">OCI_File::type</a>.</p>

</div>
</div><p>
<a class="anchor" name="g0127f1d7bcef3d1883144bb2e70299bc"></a><!-- doxytag: member="ocilib.h::OCI_FileIsEqual" ref="g0127f1d7bcef3d1883144bb2e70299bc" args="(OCI_File *file, OCI_File *file2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OCI_EXPORT boolean OCI_API OCI_FileIsEqual           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>
          <td class="paramname"> <em>file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_o_c_i___file.html">OCI_File</a> *&nbsp;</td>