[PHP-DOC] cvs: phpdoc /en/reference/pgsql/functions pg-fetch-all-columns.xml

[Christopher Kings-Lynne]

chriskl         Sun Jul 10 05:05:40 2005 EDT

  Added files:                 
    /phpdoc/en/reference/pgsql/functions        pg-fetch-all-columns.xml 
  Log:
  Add manual page for pg_fetch_all_columns()
  

http://cvs.php.net/co.php/phpdoc/en/reference/pgsql/functions/pg-fetch-all-columns.xml?r=1.1&p=1
Index: phpdoc/en/reference/pgsql/functions/pg-fetch-all-columns.xml
+++ phpdoc/en/reference/pgsql/functions/pg-fetch-all-columns.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-fetch-all-columns">
 <refnamediv>
  <refname>pg_fetch_all_columns</refname>
  <refpurpose>Fetches all rows in a particular result column as an 
array</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>pg_fetch_all_columns</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam 
choice="opt"><type>int</type><parameter>column</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_fetch_all_columns</function> returns an array that
   contains all rows (records) in a particular column of the result resource.
  </para>
  &database.fetch-null;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       PostgreSQL query result resource, returned by 
<function>pg_query</function>,
       <function>pg_query_params</function> or <function>pg_execute</function>
       (among others).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>column</parameter></term>
     <listitem>
      <para>
       Column number, zero-based, to be retrieved from the result resource.  
Defaults
       to the first column if not specified.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An <type>array</type> with all values in the result column.
  </para>
  <para>
   &false; is returned if <parameter>column</parameter> is larger than the 
number 
   of columns in the result, or on any other error.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_fetch_all_columns</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php 
$conn = pg_pconnect("dbname=publisher");
if (!$conn) {
  echo "An error occured.\n";
  exit;
}

$result = pg_query($conn, "SELECT title, name, address FROM authors");
if (!$result) {
  echo "An error occured.\n";
  exit;
}

// Get an array of all author names
$arr = pg_fetch_all_columns($result, 1);

var_dump($arr);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_fetch_all</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:"../../../../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
-->