<!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>Retrieve information about parameters to procedures</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.odbc-primarykeys.html">odbc_primarykeys</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.odbc-procedures.html">odbc_procedures</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-procedurecolumns" class="refentry">
<div class="refnamediv">
<h1 class="refname">odbc_procedurecolumns</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">odbc_procedurecolumns</span> — <span class="dc-title">Retrieve information about parameters to procedures</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.odbc-procedurecolumns-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>odbc_procedurecolumns</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection_id</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>odbc_procedurecolumns</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection_id</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">$proc</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$column</code></span>
)</div>
<p class="para rdfs-comment">
Retrieve information about parameters to procedures.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.odbc-procedurecolumns-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">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.
This parameter accepts the following search patterns:
"%" to match zero or more characters, and "_" to match a single character.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">proc</code></em></span>
<dd>
<p class="para">
The proc.
This parameter accepts the following search patterns:
"%" to match zero or more characters, and "_" to match a single character.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">column</code></em></span>
<dd>
<p class="para">
The column.
This parameter accepts the following search patterns:
"%" to match zero or more characters, and "_" to match a single character.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.odbc-procedurecolumns-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the list of input and output parameters, as well as the
columns that make up the result set for the specified procedures.
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">PROCEDURE_QUALIFIER</span></li>
<li class="listitem"><span class="simpara">PROCEDURE_OWNER</span></li>
<li class="listitem"><span class="simpara">PROCEDURE_NAME</span></li>
<li class="listitem"><span class="simpara">COLUMN_NAME</span></li>
<li class="listitem"><span class="simpara">COLUMN_TYPE</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">RADIX</span></li>
<li class="listitem"><span class="simpara">NULLABLE</span></li>
<li class="listitem"><span class="simpara">REMARKS</span></li>
</ul>
</p>
<p class="simpara">
The result set is ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER,
PROCEDURE_NAME and COLUMN_TYPE.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.odbc-primarykeys.html">odbc_primarykeys</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.odbc-procedures.html">odbc_procedures</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>
