You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/lib/cds/doc/serialize_char.xml

60 lines
1.7 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="serialize_char"> <!-- ID for references -->
<refmeta>
<refentrytitle>serialize_char</refentrytitle> <!-- title shown in references -->
<manvolnum>3</manvolnum></refmeta> <!-- man volume id (3 for libraries) -->
<refnamediv>
<refname>serialize_char</refname> <!-- function name -->
<refpurpose>character serialization</refpurpose> <!-- short function description -->
</refnamediv>
<refsynopsisdiv><funcsynopsis>
<funcsynopsisinfo>
#include &lt;cds/serialize.h&gt; <!-- included headers -->
</funcsynopsisinfo>
<funcprototype> <!-- function prototype -->
<funcdef>int <function>serialize_char</function></funcdef>
<paramdef>sstream_t *<parameter>ss</parameter></paramdef>
<paramdef>char *<parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis></refsynopsisdiv>
<refsect1><title>Description</title>
<para>Serializes character. This means that in the case of input stream this
functions sets value of given character parameter to value read from stream,
in the case of output stream it
writes the character given in parameter into that stream.
<!-- detailed description -->
</para>
</refsect1>
<refsect1><title>Return value</title>
<para>
<!-- return value description -->
Returns 0 on success, non-zero on error.
</para>
</refsect1>
<refsect1><title>See Also</title>
<para>
<xref linkend="sstream_t"/>,
<xref linkend="serialize_int"/>,
<xref linkend="serialize_uint"/>,
<xref linkend="serialize_uchar"/>,
<xref linkend="serialize_str"/>
<!-- references to other pages -->
</para>
</refsect1>
</refentry>