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
|
<?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="to_body" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
<revhistory>
<revision>
<revnumber>$Revision$</revnumber>
<date>$Date$</date>
</revision>
</revhistory>
</sectioninfo>
<title>Structure <structname>to_body</structname></title>
<para>
The structure represents parsed To body. The structure is declared in
<filename>parse_to.h</filename> file.
</para>
<para><emphasis>Structure Declaration:</emphasis></para>
<programlisting>
struct to_param {
int type; /* Type of parameter */
str name; /* Name of parameter */
str value; /* Parameter value */
struct to_param* next; /* Next parameter in the list */
};
struct to_body{
int error; /* Error code */
str body; /* The whole header field body */
str uri; /* URI */
str tag_value; /* Value of tag */
struct to_param *param_lst; /* Linked list of parameters */
struct to_param *last_param; /* Last parameter in the list */
};
</programlisting>
<para>
Structure <structname>to_param</structname> is a temporary structure
representing a To <acronym>URI</acronym> parameter. Right now only TAG
parameter will be marked in <structfield>type</structfield> field. All
other parameters will have the same type.
</para>
<para><emphasis>Field Description:</emphasis></para>
<itemizedlist>
<listitem>
<para>
<structfield>error</structfield> - Error code will be put here
when parsing of To body fails.
</para>
</listitem>
<listitem>
<para>
<structfield>body</structfield> - The whole header field body.
</para>
</listitem>
<listitem>
<para>
<structfield>uri</structfield> - <acronym>URI</acronym> of the
To header field.
</para>
</listitem>
<listitem>
<para>
<structfield>tag_value</structfield> - Value of tag parameter
if present.
</para>
</listitem>
<listitem>
<para>
<structfield>param_lst</structfield> - Linked list of all parameters.
</para>
</listitem>
<listitem>
<para>
<structfield>last_param</structfield> - Pointer to the last parameter in the linked list.
</para>
</listitem>
</itemizedlist>
</section>
|
