File: ifx-getsqlca.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (103 lines) | stat: -rw-r--r-- 3,160 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.ifx-getsqlca" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ifx_getsqlca</refname>
  <refpurpose>Get the contents of sqlca.sqlerrd[0..5] after a query</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>ifx_getsqlca</methodname>
   <methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns a pseudo-row with sqlca.sqlerrd[0] ... sqlca.sqlerrd[5] after the
   query associated with <parameter>result_id</parameter>.
  </para>
  <para>
   For inserts, updates and deletes the values returned are those as set by
   the server after executing the query. This gives access to the number of
   affected rows and the serial insert value. For <literal>SELECT</literal>s
   the values are those saved after the <literal>PREPARE</literal> statement.
   This gives access to the *estimated* number of affected rows. The use of
   this function saves the overhead of executing a <literal>SELECT 
   dbinfo('sqlca.sqlerrdx')</literal> query, as it retrieves the values that
   were saved by the ifx driver at the appropriate moment.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result_id</parameter></term>
     <listitem>
      <para>
       <parameter>result_id</parameter> is a valid result id returned by
       <function>ifx_query</function> or
       <function>ifx_prepare</function> (select type queries only!).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an associative array with the following entries:
   <literal>sqlerrd0</literal>, <literal>sqlerrd1</literal>,
   <literal>sqlerrd2</literal>, <literal>sqlerrd3</literal>,
   <literal>sqlerrd4</literal> and <literal>sqlerrd5</literal>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Retrieve Informix sqlca.sqlerrd[x] values</title>
    <programlisting role="php">
<![CDATA[
<?php
/* assume the first column of 'sometable' is a serial */
$qid = ifx_query("insert into sometable
                  values (0, '2nd column', 'another column') ", $connid);
if (!$qid) {
    /* ... error ... */
}
$sqlca = ifx_getsqlca($qid);
$serial_value = $sqlca["sqlerrd1"];
echo "The serial value of the inserted row is : $serial_value<br />\n";
?>
]]>
    </programlisting>
   </example>
  </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
-->