classcplodbcstatement.html

gdal库的学习文档

<p>
Fetch column data.<p>
Fetches the data contents of the requested column for the currently loaded row. The result is returned as a string regardless of the column type. NULL is returned if an illegal column is given, or if the actual column is "NULL".<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>iCol</em>&nbsp;</td><td>the zero based column to fetch.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pszDefault</em>&nbsp;</td><td>the value to return if the column does not exist, or is NULL. Defaults to NULL.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to internal column data or NULL on failure. </dd></dl>

</div>
</div><p>
<a class="anchor" name="8589aec3daac0c3263232c571bb1bb8d"></a><!-- doxytag: member="CPLODBCStatement::GetColData" ref="8589aec3daac0c3263232c571bb1bb8d" args="(const char *, const char *=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * CPLODBCStatement::GetColData           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszColName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszDefault</em> = <code>NULL</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch column data.<p>
Fetches the data contents of the requested column for the currently loaded row. The result is returned as a string regardless of the column type. NULL is returned if an illegal column is given, or if the actual column is "NULL".<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>pszColName</em>&nbsp;</td><td>the name of the column requested.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pszDefault</em>&nbsp;</td><td>the value to return if the column does not exist, or is NULL. Defaults to NULL.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to internal column data or NULL on failure. </dd></dl>

</div>
</div><p>
<a class="anchor" name="f6b487988cc484eda8a14d0bdb97d04b"></a><!-- doxytag: member="CPLODBCStatement::GetColumns" ref="f6b487988cc484eda8a14d0bdb97d04b" args="(const char *pszTable, const char *pszCatalog=NULL, const char *pszSchema=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int CPLODBCStatement::GetColumns           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszTable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszCatalog</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszSchema</em> = <code>NULL</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch column definitions for a table.<p>
The SQLColumn() method is used to fetch the definitions for the columns of a table (or other queriable object such as a view). The column definitions are digested and used to populate the <a class="el" href="classCPLODBCStatement.html">CPLODBCStatement</a> column definitions essentially as if a "SELECT * FROM tablename" had been done; however, no resultset will be available.<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>pszTable</em>&nbsp;</td><td>the name of the table to query information on. This should not be empty.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pszCatalog</em>&nbsp;</td><td>the catalog to find the table in, use NULL (the default) if no catalog is available.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pszSchema</em>&nbsp;</td><td>the schema to find the table in, use NULL (the default) if no schema is available.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE on success or FALSE on failure. </dd></dl>

</div>
</div><p>
<a class="anchor" name="df52034b4bb377d1ca7956b1d8c1b142"></a><!-- doxytag: member="CPLODBCStatement::GetPrimaryKeys" ref="df52034b4bb377d1ca7956b1d8c1b142" args="(const char *pszTable, const char *pszCatalog=NULL, const char *pszSchema=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int CPLODBCStatement::GetPrimaryKeys           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszTable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszCatalog</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszSchema</em> = <code>NULL</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch primary keys for a table.<p>
The SQLPrimaryKeys() function is used to fetch a list of fields forming the primary key. The result is returned as a result set matching the SQLPrimaryKeys() function result set. The 4th column in the result set is the column name of the key, and if the result set contains only one record then that single field will be the complete primary key.<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>pszTable</em>&nbsp;</td><td>the name of the table to query information on. This should not be empty.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pszCatalog</em>&nbsp;</td><td>the catalog to find the table in, use NULL (the default) if no catalog is available.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pszSchema</em>&nbsp;</td><td>the schema to find the table in, use NULL (the default) if no schema is available.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE on success or FALSE on failure. </dd></dl>

</div>
</div><p>
<a class="anchor" name="17d2640dd75d50f4d37a33ad372f606d"></a><!-- doxytag: member="CPLODBCStatement::GetTables" ref="17d2640dd75d50f4d37a33ad372f606d" args="(const char *pszCatalog=NULL, const char *pszSchema=NULL)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int CPLODBCStatement::GetTables           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszCatalog</em> = <code>NULL</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>pszSchema</em> = <code>NULL</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fetch tables in database.<p>
The SQLTables() function is used to fetch a list tables in the database. The result is returned as a result set matching the SQLTables() function result set. The 3rd column in the result set is the table name. Only tables of type "TABLE" are returned.<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>pszCatalog</em>&nbsp;</td><td>the catalog to find the table in, use NULL (the default) if no catalog is available.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pszSchema</em>&nbsp;</td><td>the schema to find the table in, use NULL (the default) if no schema is available.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE on success or FALSE on failure. </dd></dl>

</div>
</div><p>
<a class="anchor" name="aac8fabff87844776f9198786fbf8cab"></a><!-- doxytag: member="CPLODBCStatement::DumpResult" ref="aac8fabff87844776f9198786fbf8cab" args="(FILE *fp, int bShowSchema=FALSE)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPLODBCStatement::DumpResult           </td>
          <td>(</td>
          <td class="paramtype">FILE *&nbsp;</td>
          <td class="paramname"> <em>fp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>bShowSchema</em> = <code>FALSE</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Dump resultset to file.<p>
The contents of the current resultset are dumped in a simply formatted form to the provided file. If requested, the schema definition will be written first.<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>fp</em>&nbsp;</td><td>the file to write to. stdout or stderr are acceptable.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>bShowSchema</em>&nbsp;</td><td>TRUE to force writing schema information for the rowset before the rowset data itself. Default is FALSE. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="e9f475371e9ff2f91e6514668803900b"></a><!-- doxytag: member="CPLODBCStatement::GetTypeName" ref="e9f475371e9ff2f91e6514668803900b" args="(int)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CPLString CPLODBCStatement::GetTypeName           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>nTypeCode</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get name for SQL column type.<p>
Returns a string name for the indicated type code (as returned from <a class="el" href="classCPLODBCStatement.html#cefccc2295341b2ef09e0ad9be5ec9e2">CPLODBCStatement::GetColType()</a>).<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>nTypeCode</em>&nbsp;</td><td>the SQL_ code, such as SQL_CHAR.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>internal string, "UNKNOWN" if code not recognised. </dd></dl>

</div>
</div><p>
<a class="anchor" name="fe650707128654709da20449ee440f2a"></a><!-- doxytag: member="CPLODBCStatement::GetTypeMapping" ref="fe650707128654709da20449ee440f2a" args="(SQLSMALLINT)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SQLSMALLINT CPLODBCStatement::GetTypeMapping           </td>
          <td>(</td>
          <td class="paramtype">SQLSMALLINT&nbsp;</td>
          <td class="paramname"> <em>nTypeCode</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get appropriate C data type for SQL column type.<p>
Returns a C data type code, corresponding to the indicated SQL data type code (as returned from <a class="el" href="classCPLODBCStatement.html#cefccc2295341b2ef09e0ad9be5ec9e2">CPLODBCStatement::GetColType()</a>).<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>nTypeCode</em>&nbsp;</td><td>the SQL_ code, such as SQL_CHAR.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>data type code. The valid code is always returned. If SQL code is not recognised, SQL_C_BINARY will be returned. </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cpl__odbc_8h-source.html">cpl_odbc.h</a><li>cpl_odbc.cpp</ul>
<hr>

Generated for GDAL by 
<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1.
</body>
</html>