File: msql-result.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (94 lines) | stat: -rw-r--r-- 2,831 bytes parent folder | download
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.msql-result" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>msql_result</refname>
  <refpurpose>Get result data</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>msql_result</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam><type>int</type><parameter>row</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>field</parameter></methodparam>
  </methodsynopsis>
  <para> 
   <function>msql_result</function> returns the contents of one cell from a 
   mSQL result set.  
  </para>
  <para> 
   When working on large result sets, you should consider using one of the 
   functions that fetch an entire row (specified below). As these functions
   return the contents of multiple cells in one function call, they are often
   much quicker than <function>msql_result</function>.  
  </para>
  <para> 
   Recommended high-performance alternatives:
   <function>msql_fetch_row</function>,
   <function>msql_fetch_array</function>, and
   <function>msql_fetch_object</function>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &msql.result.description;
   <varlistentry>
     <term><parameter>row</parameter></term>
     <listitem>
      <para>
       The row offset.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>field</parameter></term>
     <listitem>
      <para>
       Can be the field's offset, or the field's name, or the field's table
       dot field's name (tablename.fieldname.). If the column name has been 
       aliased ('select foo as bar from ...'), use the alias instead of the
       column name.
      </para>
      <note>
       <para>
        Specifying a numeric field offset is much quicker than specifying a 
        fieldname or tablename.fieldname.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;  
  <para>
   Returns the contents of the cell at the row and offset in the
   specified mSQL result set.
  </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
-->