Source of: /manual/en/function.odbc-procedurecolumns.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-procedurecolumns.php',
1 => 'odbc_procedurecolumns',
),
'up' =>
array (
0 => 'ref.uodbc.php',
1 => 'ODBC Functions',
),
'prev' =>
array (
0 => 'function.odbc-primarykeys.php',
1 => 'odbc_primarykeys',
),
'next' =>
array (
0 => 'function.odbc-procedures.php',
1 => 'odbc_procedures',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<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>
<a name="function.odbc-procedurecolumns.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_procedurecolumns</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$connection_id</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>odbc_procedurecolumns</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$connection_id</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">$proc</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$column</tt></span>
)</div>
<p class="para rdfs-comment">
Retrieve information about parameters to procedures.
</p>
</div>
<a name="function.odbc-procedurecolumns.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">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.
This parameter accepts the following search patterns:
"%" to match zero or more characters, and "_" to match a single character.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">proc</tt></i>
</span>
</dt><dd class="listitem">
<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 class="varlistentry">
<span class="term"><i><tt class="parameter">column</tt></i>
</span>
</dt><dd class="listitem">
<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>
</dl>
<p>
</p>
</div>
<a name="function.odbc-procedurecolumns.returnvalues"></a><div class="refsect1 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 <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">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>
<p class="simpara">
The result set is ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER,
PROCEDURE_NAME and COLUMN_TYPE.
</p>
</div>
</div><?php manual_footer(); ?>
