Source of: /manual/en/function.odbc-specialcolumns.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.uodbc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.odbc-specialcolumns.php',
1 => 'odbc_specialcolumns',
),
'up' =>
array (
0 => 'ref.uodbc.php',
1 => 'ODBC Functions',
),
'prev' =>
array (
0 => 'function.odbc-setoption.php',
1 => 'odbc_setoption',
),
'next' =>
array (
0 => 'function.odbc-statistics.php',
1 => 'odbc_statistics',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.odbc-specialcolumns" class="refentry">
<div class="refnamediv">
<h1 class="refname">odbc_specialcolumns</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">odbc_specialcolumns</span> — <span class="dc-title">Retrieves special columns</span></p>
</div>
<a name="function.odbc-specialcolumns.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>odbc_specialcolumns</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$connection_id</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$type</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$qualifier</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$owner</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$table</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$scope</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$nullable</tt></span>
)</div>
<p class="para rdfs-comment">
Retrieves either the optimal set of columns that uniquely identifies a
row in the table, or columns that are automatically updated when any
value in the row is updated by a transaction.
</p>
</div>
<a name="function.odbc-specialcolumns.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">connection_id</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">The ODBC connection identifier,
see <a href="function.odbc-connect.php" class="function">odbc_connect()</a> for details.</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">type</tt></i>
</span>
</dt><dd class="listitem">
<span class="simpara">
When the type argument is <b><tt class="constant">SQL_BEST_ROWID</tt></b>,
<b>odbc_specialcolumns()</b> returns the
column or columns that uniquely identify each row in the table.
</span>
<span class="simpara">
When the type argument is <b><tt class="constant">SQL_ROWVER</tt></b>,
<b>odbc_specialcolumns()</b> returns the column or columns in the
specified table, if any, that are automatically updated by the data source
when any value in the row is updated by any transaction.
</span>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">qualifier</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The qualifier.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">owner</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The owner.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">table</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The table.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">scope</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The scope, which orders the result set.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">nullable</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The nullable option.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.odbc-specialcolumns.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an ODBC result identifier or <b><tt class="constant">FALSE</tt></b> on
failure.
</p>
<p class="para">
The result set has the following columns:
</p><ul class="itemizedlist">
<li class="listitem"><span class="simpara">SCOPE</span></li>
<li class="listitem"><span class="simpara">COLUMN_NAME</span></li>
<li class="listitem"><span class="simpara">DATA_TYPE</span></li>
<li class="listitem"><span class="simpara">TYPE_NAME</span></li>
<li class="listitem"><span class="simpara">PRECISION</span></li>
<li class="listitem"><span class="simpara">LENGTH</span></li>
<li class="listitem"><span class="simpara">SCALE</span></li>
<li class="listitem"><span class="simpara">PSEUDO_COLUMN</span></li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
