<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Retrieves special columns</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.odbc-setoption.html">odbc_setoption</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.odbc-statistics.html">odbc_statistics</a></div>
<div class="up"><a href="ref.uodbc.html">ODBC Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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>
<div class="refsect1 description" id="refsect1-function.odbc-specialcolumns-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>odbc_specialcolumns</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection_id</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$qualifier</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$owner</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$table</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$scope</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$nullable</code></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>
<div class="refsect1 parameters" id="refsect1-function.odbc-specialcolumns-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection_id</code></em></span>
<dd>
<p class="para">The ODBC connection identifier,
see <span class="function"><a href="function.odbc-connect.html" class="function">odbc_connect()</a></span> for details.</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<span class="simpara">
When the type argument is <strong><code>SQL_BEST_ROWID</code></strong>,
<span class="function"><strong>odbc_specialcolumns()</strong></span> returns the
column or columns that uniquely identify each row in the table.
</span>
<span class="simpara">
When the type argument is <strong><code>SQL_ROWVER</code></strong>,
<span class="function"><strong>odbc_specialcolumns()</strong></span> 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>
<dt>
<span class="term"><em><code class="parameter">qualifier</code></em></span>
<dd>
<p class="para">
The qualifier.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">owner</code></em></span>
<dd>
<p class="para">
The owner.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">table</code></em></span>
<dd>
<p class="para">
The table.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">scope</code></em></span>
<dd>
<p class="para">
The scope, which orders the result set.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">nullable</code></em></span>
<dd>
<p class="para">
The nullable option.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.odbc-specialcolumns-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an ODBC result identifier or <strong><code>FALSE</code></strong> on
failure.
</p>
<p class="para">
The result set has the following columns:
<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>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.odbc-setoption.html">odbc_setoption</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.odbc-statistics.html">odbc_statistics</a></div>
<div class="up"><a href="ref.uodbc.html">ODBC Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
