php-doc-en/reference/ibase/functions/ibase-blob-get.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.ibase-blob-get'>
 <refnamediv>
  <refname>ibase_blob_get</refname>
  <refpurpose>Get len bytes data from open blob</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>ibase_blob_get</methodname>
   <methodparam><type>resource</type><parameter>blob_handle</parameter></methodparam>
   <methodparam><type>int</type><parameter>len</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function returns at most <parameter>len</parameter> bytes from a BLOB
   that has been opened for reading by <function>ibase_blob_open</function>.
  </para>
  <note>
   <para>
    It is not possible to read from a BLOB that has been opened for writing
    by <function>ibase_blob_create</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>blob_handle</parameter></term>
     <listitem>
      <para>
       A BLOB handle opened with <function>ibase_blob_open</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>len</parameter></term>
     <listitem>
      <para>
       Size of returned data.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns at most <parameter>len</parameter> bytes from the BLOB, or &false;
   on failure.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ibase_blob_get</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$result    = ibase_query("SELECT blob_value FROM table");
$data      = ibase_fetch_object($result);
$blob_data = ibase_blob_info($data->BLOB_VALUE);
$blob_hndl = ibase_blob_open($data->BLOB_VALUE);
echo         ibase_blob_get($blob_hndl, $blob_data[0]);
?>
]]>
    </programlisting>
   </example>
   Whilst this example doesn't do much more than a
   'ibase_blob_echo($data->BLOB_VALUE)' would do, it does show you how to get
   information into a $variable to manipulate as you please. 
  </para>
 </refsect1>

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