~xubuntu-dev/libxfce4util/maverick

<refentry id="libxfce4util-Unicode-Support-Functions">

<refmeta>

<refentrytitle role="top_of_page">Unicode Manipulation</refentrytitle>

<manvolnum>3</manvolnum>

<refmiscinfo>LIBXFCE4UTIL Library</refmiscinfo>

</refmeta>

 

<refnamediv>

<refname>Unicode Manipulation</refname>

<refpurpose>functions operating on Unicode characters and UTF-8 strings.</refpurpose>

<!--[<xref linkend="desc" endterm="desc.title"/>]-->

</refnamediv>

 

<refsynopsisdiv role="synopsis">

<title role="synopsis.title">Synopsis</title>

 

<synopsis>

 

#include &lt;libxfce4util/libxfce4util.h&gt;

 

 

<link linkend="gchar">gchar</link>*              <link linkend="xfce-utf8-remove-controls">xfce_utf8_remove_controls</link>           (<link linkend="gchar">gchar</link> *str,

                                                         <link linkend="gssize">gssize</link> max_len,

                                                         const <link linkend="gchar">gchar</link> *end);

<link linkend="gchar">gchar</link>*              <link linkend="xfce-utf8-strndup">xfce_utf8_strndup</link>                   (const <link linkend="gchar">gchar</link> *src,

                                                         <link linkend="gssize">gssize</link> max_len);

</synopsis>

</refsynopsisdiv>

 

 

 

 

 

 

 

 

 

<refsect1 role="desc">

<title role="desc.title">Description</title>

<para>

</para>

</refsect1>

 

<refsect1 role="details">

<title role="details.title">Details</title>

<refsect2>

<title><anchor id="xfce-utf8-remove-controls" role="function" condition="since:4.2"/>xfce_utf8_remove_controls ()</title>

<indexterm role="4.2"><primary>xfce_utf8_remove_controls</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              xfce_utf8_remove_controls           (<link linkend="gchar">gchar</link> *str,

                                                         <link linkend="gssize">gssize</link> max_len,

                                                         const <link linkend="gchar">gchar</link> *end);</programlisting>

<para>

Removes all control characters from <parameter>str</parameter> up to <parameter>end</parameter> or up to

<parameter>max_len</parameter> characters (note that characters does not mean bytes with

UTF-8), where both <parameter>str</parameter> and <parameter>max_len</parameter> may not be given.

</para>

<para>

Control characters are replaced in <parameter>str</parameter> by whitespaces, no new string

will be allocated. The operation is done in-place.</para>

<para>

 

</para><variablelist role="params">

<varlistentry><term><parameter>str</parameter>&nbsp;:</term>

<listitem><simpara> target string.

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>max_len</parameter>&nbsp;:</term>

<listitem><simpara> max characters to check or -1 for no character limit.

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>end</parameter>&nbsp;:</term>

<listitem><simpara> pointer to the endpoint in <parameter>str</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for no endpoint.

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> pointer to <parameter>str</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error.

 

</simpara></listitem></varlistentry>

</variablelist><para role="since">Since  4.2

</para></refsect2>

<refsect2>

<title><anchor id="xfce-utf8-strndup" role="function" condition="since:4.3"/>xfce_utf8_strndup ()</title>

<indexterm role="4.3"><primary>xfce_utf8_strndup</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              xfce_utf8_strndup                   (const <link linkend="gchar">gchar</link> *src,

                                                         <link linkend="gssize">gssize</link> max_len);</programlisting>

<para>

Duplicates the <parameter>src</parameter> string up to <parameter>max_len</parameter> characters 

(note that characters does not mean bytes with UTF-8).

</para>

<para>

The caller is responsible to free the returned string

using <link linkend="g-free"><function>g_free()</function></link> when no longer needed.</para>

<para>

 

</para><variablelist role="params">

<varlistentry><term><parameter>src</parameter>&nbsp;:</term>

<listitem><simpara> target string.

</simpara></listitem></varlistentry>

<varlistentry><term><parameter>max_len</parameter>&nbsp;:</term>

<listitem><simpara> max characters to duplicate or -1 for no character limit.

</simpara></listitem></varlistentry>

<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> pointer to the newly allocated string.

 

</simpara></listitem></varlistentry>

</variablelist><para role="since">Since  4.3

</para></refsect2>

 

</refsect1>

 

 

 

<refsect1>

<title>See Also</title>

<para>

<ulink url="http://developer.gnome.org/doc/API/2.0/glib/glib-Unicode-Manipulation.html">Glib Unicode Manipulation</ulink>

</para>

</refsect1>

 

</refentry>