php-doc-en/reference/pgsql/functions/pg-lo-read-all.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry xml:id="function.pg-lo-read-all" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_lo_read_all</refname>
  <refpurpose>
   Reads an entire large object and send straight to browser
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>pg_lo_read_all</methodname>
   <methodparam><type>resource</type><parameter>large_object</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_lo_read_all</function> reads a large object and passes
   it straight through to the browser after sending all pending
   headers. Mainly intended for sending binary data like images or
   sound.
  </para>
  <para>
   To use the large object interface, it is necessary to
   enclose it within a transaction block.
  </para>
  <note>
   <para>
    This function used to be called <function>pg_loreadall</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>large_object</parameter></term>
     <listitem>
      <para>
       PostgreSQL large object (LOB) resource, returned by <function>pg_lo_open</function>.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Number of bytes read or &false; on error.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_lo_read_all</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
   header('Content-type: image/jpeg');
   $image_oid = 189762345;
   $database = pg_connect("dbname=jacarta");
   pg_query($database, "begin");
   $handle = pg_lo_open($database, $image_oid, "r");
   pg_lo_read_all($handle);
   pg_query($database, "commit");
?>
]]>
    </programlisting>
   </example> 
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_lo_read</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
-->