mirror of https://github.com/sipwise/kamailio.git
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.
60 lines
1.6 KiB
60 lines
1.6 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_str"> <!-- ID for references -->
|
|
|
|
<refmeta>
|
|
<refentrytitle>serialize_str</refentrytitle> <!-- title shown in references -->
|
|
<manvolnum>3</manvolnum></refmeta> <!-- man volume id (3 for libraries) -->
|
|
|
|
<refnamediv>
|
|
<refname>serialize_str</refname> <!-- function name -->
|
|
<refpurpose>string serialization</refpurpose> <!-- short function description -->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <cds/serialize.h> <!-- included headers -->
|
|
</funcsynopsisinfo>
|
|
|
|
<funcprototype> <!-- function prototype -->
|
|
<funcdef>int <function>serialize_str</function></funcdef>
|
|
<paramdef>sstream_t *<parameter>ss</parameter></paramdef>
|
|
<paramdef>str_t *<parameter>s</parameter></paramdef>
|
|
</funcprototype>
|
|
|
|
</funcsynopsis></refsynopsisdiv>
|
|
|
|
<refsect1><title>Description</title>
|
|
<para>Serializes string. This means that in the case of input stream this
|
|
functions reads string from the stream (allocated using cds_malloc),
|
|
in the case of output stream it
|
|
writes the given string 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_char"/>,
|
|
<xref linkend="serialize_uchar"/>
|
|
<!-- references to other pages -->
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|