modules/ims_qos: added patch for flow-description bug when request originates from...
[sip-router] / src / lib / cds / doc / serialize_uint.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
4    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <refentry id="serialize_uint"> <!-- ID for references -->
7
8 <refmeta>
9 <refentrytitle>serialize_uint</refentrytitle> <!-- title shown in references -->
10 <manvolnum>3</manvolnum></refmeta> <!-- man volume id (3 for libraries) -->
11
12 <refnamediv>
13 <refname>serialize_uint</refname> <!-- function name -->
14 <refpurpose>unsigned integer serialization</refpurpose> <!-- short function description -->
15 </refnamediv>
16
17 <refsynopsisdiv><funcsynopsis>
18 <funcsynopsisinfo>
19 #include &lt;cds/serialize.h&gt; <!-- included headers -->
20 </funcsynopsisinfo>
21
22 <funcprototype> <!-- function prototype -->
23   <funcdef>int <function>serialize_uint</function></funcdef>
24   <paramdef>sstream_t *<parameter>ss</parameter></paramdef>
25   <paramdef>unsigned int *<parameter>num</parameter></paramdef>
26 </funcprototype>
27
28 </funcsynopsis></refsynopsisdiv>
29
30 <refsect1><title>Description</title>
31 <para>Serializes number. This means that in the case of input stream this
32 functions sets value of given unsigned integer parameter to value read from stream, 
33 in the case of output stream it
34 writes the number given in parameter into that stream.
35 <!-- detailed description -->
36 </para>
37
38 </refsect1>
39
40 <refsect1><title>Return value</title>
41 <para>
42 <!-- return value description -->
43 Returns 0 on success, non-zero on error.
44 </para>
45 </refsect1>
46
47 <refsect1><title>See Also</title>
48 <para>
49 <xref linkend="sstream_t"/>, 
50 <xref linkend="serialize_int"/>, 
51 <xref linkend="serialize_char"/>, 
52 <xref linkend="serialize_uchar"/>, 
53 <xref linkend="serialize_str"/>
54 <!-- references to other pages -->
55 </para>
56 </refsect1>
57
58 </refentry> 
59