<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: ed1aff13602c94f86344bdd7c4fbc31f5a71bf84 Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="function.odbc-procedurecolumns" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>odbc_procedurecolumns</refname>

<refpurpose>Lista los parámetros de los procedimientos</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_procedurecolumns</methodname>

<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>procedure</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>column</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

Lista los parámetros de los procedimientos.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>odbc</parameter></term>

<listitem>

&odbc.connection.id;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>catalog</parameter></term>

<listitem>

<para>

&odbc.parameter.catalog;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>schema</parameter></term>

<listitem>

<para>

&odbc.parameter.schema;

&odbc.parameter.search;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>procedure</parameter></term>

<listitem>

<para>

El procedimiento.

&odbc.parameter.search;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>column</parameter></term>

<listitem>

<para>

La columna.

&odbc.parameter.search;

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve los parámetros de entrada y salida, así como las columnas

utilizadas en los procedimientos designados por los argumentos.

&odbc.result.object-return-falseforfailure;

</para>

<para>

El conjunto de resultados contiene las siguientes columnas:

<itemizedlist>

<listitem><simpara><literal>PROCEDURE_CAT</literal></simpara></listitem>

<listitem><simpara><literal>PROCEDURE_SCHEM</literal></simpara></listitem>

<listitem><simpara><literal>PROCEDURE_NAME</literal></simpara></listitem>

<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>

<listitem><simpara><literal>COLUMN_TYPE</literal></simpara></listitem>

<listitem><simpara><literal>DATA_TYPE</literal></simpara></listitem>

<listitem><simpara><literal>TYPE_NAME</literal></simpara></listitem>

<listitem><simpara><literal>COLUMN_SIZE</literal></simpara></listitem>

<listitem><simpara><literal>BUFFER_LENGTH</literal></simpara></listitem>

<listitem><simpara><literal>DECIMAL_DIGITS</literal></simpara></listitem>

<listitem><simpara><literal>NUM_PREC_RADIX</literal></simpara></listitem>

<listitem><simpara><literal>NULLABLE</literal></simpara></listitem>

<listitem><simpara><literal>REMARKS</literal></simpara></listitem>

<listitem><simpara><literal>COLUMN_DEF</literal></simpara></listitem>

<listitem><simpara><literal>SQL_DATA_TYPE</literal></simpara></listitem>

<listitem><simpara><literal>SQL_DATETIME_SUB</literal></simpara></listitem>

<listitem><simpara><literal>CHAR_OCTET_LENGTH</literal></simpara></listitem>

<listitem><simpara><literal>ORDINAL_POSITION</literal></simpara></listitem>

<listitem><simpara><literal>IS_NULLABLE</literal></simpara></listitem>

</itemizedlist>

&odbc.result.driver-specific;

</para>

<simpara>

El conjunto de resultados está ordenado por <literal>PROCEDURE_CAT</literal>, <literal>PROCEDURE_SCHEM</literal>,

<literal>PROCEDURE_NAME</literal> y <literal>COLUMN_TYPE</literal>.

</simpara>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&odbc.changelog.connection-param;

&odbc.changelog.result-return;

<row>

<entry>8.0.0</entry>

<entry>

Antes de esta versión, la función solo podía ser llamada con uno o cinco argumentos.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example xml:id="odbc-procedurecolumns.example.basic">

<title>Lista las columnas de un procedimiento almacenado</title>

<programlisting role="php">

<![CDATA[

<?php

$conn = odbc_connect($dsn, $user, $pass);

$columns = odbc_procedurecolumns($conn, 'TutorialDB', 'dbo', 'GetEmployeeSalesYTD;1', '%');

while (($row = odbc_fetch_array($columns))) {

print_r($row);

break; // filas adicionales omitidas por brevedad

}

?>

]]>

</programlisting>

&example.outputs.similar;

<screen>

<![CDATA[

Array

(

[PROCEDURE_CAT] => TutorialDB

[PROCEDURE_SCHEM] => dbo

[PROCEDURE_NAME] => GetEmployeeSalesYTD;1

[COLUMN_NAME] => @SalesPerson

[COLUMN_TYPE] => 1

[DATA_TYPE] => -9

[TYPE_NAME] => nvarchar

[COLUMN_SIZE] => 50

[BUFFER_LENGTH] => 100

[DECIMAL_DIGITS] =>

[NUM_PREC_RADIX] =>

[NULLABLE] => 1

[REMARKS] =>

[COLUMN_DEF] =>

[SQL_DATA_TYPE] => -9

[SQL_DATETIME_SUB] =>

[CHAR_OCTET_LENGTH] => 100

[ORDINAL_POSITION] => 1

[IS_NULLABLE] => YES

)

]]>

</screen>

</example>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>odbc_columns</function></member>

</simplelist>

</para>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->