<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = 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 => 'de',
  ),
  'this' => 
  array (
    0 => 'function.odbc-procedurecolumns.php',
    1 => 'odbc_procedurecolumns',
    2 => 'Retrieve information about parameters to procedures',
  ),
  'up' => 
  array (
    0 => 'ref.uodbc.php',
    1 => 'ODBC Funktionen',
  ),
  'prev' => 
  array (
    0 => 'function.odbc-primarykeys.php',
    1 => 'odbc_primarykeys',
  ),
  'next' => 
  array (
    0 => 'function.odbc-procedures.php',
    1 => 'odbc_procedures',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/uodbc/functions/odbc-procedurecolumns.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.odbc-procedurecolumns" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">odbc_procedurecolumns</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">odbc_procedurecolumns</span> &mdash; <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">Beschreibung</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>odbc_procedurecolumns</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type">Odbc\Connection</span> <code class="parameter">$odbc</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$catalog</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$schema</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$procedure</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$column</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><span class="type">Odbc\Result</span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></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">Parameter-Liste</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">odbc</code></dt>
     <dd>
      <p class="para">Das ODBC-Verbindungs-Objekt,
siehe <span class="function"><a href="function.odbc-connect.php" class="function">odbc_connect()</a></span> für Details.</p>
     </dd>
    
    
     <dt><code class="parameter">catalog</code></dt>
     <dd>
      <p class="para">
       Der Katalog (&#039;Kennzeichner&#039; in ODBC 2 Terminologie).
      </p>
     </dd>
    
    
     <dt><code class="parameter">schema</code></dt>
     <dd>
      <p class="para">
       Das Schema (&#039;Besitzer&#039; in ODBC 2 Terminologie).
       Dieser Parameter akzeptiert die
folgenden Suchmuster: <code class="literal">%</code> für 0 oder mehr Zeichen und <code class="literal">_</code>
für genau ein beliebiges Zeichen.
      </p>
     </dd>
    
    
     <dt><code class="parameter">procedure</code></dt>
     <dd>
      <p class="para">
       The proc.
       Dieser Parameter akzeptiert die
folgenden Suchmuster: <code class="literal">%</code> für 0 oder mehr Zeichen und <code class="literal">_</code>
für genau ein beliebiges Zeichen.
      </p>
     </dd>
    
    
     <dt><code class="parameter">column</code></dt>
     <dd>
      <p class="para">
       The column.
       Dieser Parameter akzeptiert die
folgenden Suchmuster: <code class="literal">%</code> für 0 oder mehr Zeichen und <code class="literal">_</code>
für genau ein beliebiges Zeichen.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.odbc-procedurecolumns-returnvalues">
  <h3 class="title">Rückgabewerte</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. 
   Gibt ein ODBC-Ergebnis-Objekt zurückBei einem Fehler wird <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> zurückgegeben..
  </p>
  <p class="para">
   The result set has the following columns:
   <ul class="itemizedlist">
    <li class="listitem"><span class="simpara"><code class="literal">PROCEDURE_CAT</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">PROCEDURE_SCHEM</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">PROCEDURE_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">COLUMN_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">COLUMN_TYPE</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">DATA_TYPE</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">TYPE_NAME</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">COLUMN_SIZE</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">BUFFER_LENGTH</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">DECIMAL_DIGITS</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">NUM_PREC_RADIX</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">NULLABLE</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">REMARKS</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">COLUMN_DEF</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">SQL_DATA_TYPE</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">SQL_DATETIME_SUB</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">CHAR_OCTET_LENGTH</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">ORDINAL_POSITION</code></span></li>
    <li class="listitem"><span class="simpara"><code class="literal">IS_NULLABLE</code></span></li>
   </ul>
   Treiber können zusätzliche Spalten melden.
  </p>
  <p class="simpara">
   The result set is ordered by <code class="literal">PROCEDURE_CAT</code>, <code class="literal">PROCEDURE_SCHEM</code>,
   <code class="literal">PROCEDURE_NAME</code> and <code class="literal">COLUMN_TYPE</code>.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.odbc-procedurecolumns-changelog">
  <h3 class="title">Changelog</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Beschreibung</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.4.0</td>
 <td>
  <code class="parameter">odbc</code> erwartet nun eine Instanz von
  <span class="classname"><strong class="classname">Odbc\Connection</strong></span>; vorher wurde eine
  <span class="type">Ressource</span> erwartet.
 </td>
</tr>

     <tr>
 <td>8.4.0</td>
 <td>
   Diese Funktion gibt nun eine Instanz von <span class="classname"><strong class="classname">Odbc\Result</strong></span>
   zurück; vorher wurde eine <span class="type">Ressource</span> zurückgegeben.
 </td>
</tr>

     <tr>
      <td>8.0.0</td>
      <td>
       Prior to this version, the function could only be called with either one
       or five arguments.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.odbc-procedurecolumns-examples">
  <h3 class="title">Beispiele</h3>
  <div class="example" id="odbc-procedurecolumns.example.basic">
   <p><strong>Beispiel #1 List Columns of a stored Procedure</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">odbc_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$dsn</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$pass</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$columns </span><span style="color: #007700">= </span><span style="color: #0000BB">odbc_procedurecolumns</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">'TutorialDB'</span><span style="color: #007700">, </span><span style="color: #DD0000">'dbo'</span><span style="color: #007700">, </span><span style="color: #DD0000">'GetEmployeeSalesYTD;1'</span><span style="color: #007700">, </span><span style="color: #DD0000">'%'</span><span style="color: #007700">);<br />while ((</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">odbc_fetch_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$columns</span><span style="color: #007700">))) {<br />    </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$row</span><span style="color: #007700">);<br />    break; </span><span style="color: #FF8000">// further rows omitted for brevity<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>Das oben gezeigte Beispiel erzeugt
eine ähnliche Ausgabe wie:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [PROCEDURE_CAT] =&gt; TutorialDB
    [PROCEDURE_SCHEM] =&gt; dbo
    [PROCEDURE_NAME] =&gt; GetEmployeeSalesYTD;1
    [COLUMN_NAME] =&gt; @SalesPerson
    [COLUMN_TYPE] =&gt; 1
    [DATA_TYPE] =&gt; -9
    [TYPE_NAME] =&gt; nvarchar
    [COLUMN_SIZE] =&gt; 50
    [BUFFER_LENGTH] =&gt; 100
    [DECIMAL_DIGITS] =&gt;
    [NUM_PREC_RADIX] =&gt;
    [NULLABLE] =&gt; 1
    [REMARKS] =&gt;
    [COLUMN_DEF] =&gt;
    [SQL_DATA_TYPE] =&gt; -9
    [SQL_DATETIME_SUB] =&gt;
    [CHAR_OCTET_LENGTH] =&gt; 100
    [ORDINAL_POSITION] =&gt; 1
    [IS_NULLABLE] =&gt; YES
)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.odbc-procedurecolumns-seealso">
  <h3 class="title">Siehe auch</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.odbc-columns.php" class="function" rel="rdfs-seeAlso">odbc_columns()</a> - Lists the column names in specified tables</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>