php-doc-en/reference/ibase/functions/ibase-query.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ibase-query">
 <refnamediv>
  <refname>ibase_query</refname>
  <refpurpose>Execute a query on an InterBase database</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>ibase_query</methodname>
   <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
   <methodparam><type>string</type><parameter>query</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>bind_args</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Performs a query on an InterBase database. 
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>link_identifier</parameter></term>
     <listitem>
      <para>
       An InterBase link identifier. If omitted, the last opened link is
       assumed.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>query</parameter></term>
     <listitem>
      <para>
       An InterBase query.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bind_args</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   If the query raises an error, returns &false;. If it is successful and
   there is a (possibly empty) result set (such as with a SELECT query),
   returns a result identifier. If the query was successful and there were
   no results, returns &true;.
  </para>
  <note>
   <para>
    In PHP 5.0.0 and up, this function will return the number of rows
    affected by the query for INSERT, UPDATE and DELETE statements. In order
    to retain backward compatibility, it will return &true; for these
    statements if the query succeeded without affecting any rows.
   </para>
  </note>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   If you get some error like "arithmetic exception, numeric overflow, or
   string truncation. Cannot transliterate character between character sets"
   (this occurs when you try use some character with accents) when using this
   and after <function>ibase_query</function> you must set the character set
   (i.e. ISO8859_1 or your current character set).
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.1</entry>
       <entry>
        On success the function now returns &true; if there were no 
        affected rows, where it previously returned <literal>0 </literal> 
        (a zero followed by an empty space).
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ibase_query</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$host = 'localhost:/path/to/your.gdb';

$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';

$sth = ibase_query($dbh, $stmt) or die(ibase_errmsg());

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ibase_errmsg</function></member>
    <member><function>ibase_fetch_row</function></member>
    <member><function>ibase_fetch_object</function></member>
    <member><function>ibase_free_result</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
-->