File: db_row_t.xml

package info (click to toggle)
kamailio 5.6.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 68,332 kB
  • sloc: ansic: 744,091; xml: 196,848; cpp: 14,471; makefile: 8,859; sh: 8,814; sql: 7,844; yacc: 3,863; perl: 2,955; python: 2,710; java: 449; javascript: 269; php: 258; ruby: 225; cs: 40; awk: 27
file content (74 lines) | stat: -rw-r--r-- 1,766 bytes parent folder | download | duplicates (9)
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<section id="db_row_t" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
	<revhistory>
	    <revision>
		<revnumber>$Revision$</revnumber>
		<date>$Date$</date>
	    </revision>
	</revhistory>
    </sectioninfo>
    
    <title>Type <type>db_row_t</type></title>
    <para>
	This type represents one row in a database table. In other words, the
	row is an array of <type>db_val_t</type> variables, where each
	<type>db_val_t</type> variable represents exactly one cell in the
	table.
    </para>
    <programlisting>
typedef struct db_row {
    db_val_t* values;    /* Array of values in the row */
    int n;               /* Number of values in the row */
} db_val_t;
    </programlisting>
    <itemizedlist>
	<listitem>
	    <para>
		<function>ROW_VALUES(row)</function> Macro.
	    </para>
	    <para>
		Use this macro to get pointer to array of <type>db_val_t</type>
		structures.
	    </para>
	    <example>
		<title>ROW_VALUES Macro</title>
		<programlisting>
...
db_val_t* v = ROW_VALUES(row);
if (VAL_TYPE(v) == DB_INT)
...
		</programlisting>
	    </example>
	</listitem>
	
	<listitem>
	    <para>
		<function>ROW_N(row)</function> Macro.
	    </para>
	    <para>
		Use this macro to get number of cells in a row.
	    </para>
	    <example>
		<title>ROW_N Macro</title>
		<programlisting>
<![CDATA[
...
db_val_t* val = ROW_VALUES(row);
for(i = 0; i < ROW_N(row); i++) {
    switch(VAL_TYPE(val + i)) {
        case DB_INT: ...; break;
        case DB_DOUBLE: ...; break;
        ...
    }
}
...
]]>
		</programlisting>
	    </example>
	</listitem>
    </itemizedlist>
</section>