git.sur5r.net Git - glabels/blob - docs/libglabels/xml/str.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="libglabels-str">
   6 <refmeta>
   7 <refentrytitle role="top_of_page" id="libglabels-str.top_of_page">String Utility Functions</refentrytitle>
   8 <manvolnum>3</manvolnum>
   9 <refmiscinfo>LIBGLABELS Library</refmiscinfo>
  10 </refmeta>
  11
  12 <refnamediv>
  13 <refname>String Utility Functions</refname>
  14 <refpurpose>String utility functions provided by libglabels</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv id="libglabels-str.synopsis" role="synopsis">
  18 <title role="synopsis.title">Synopsis</title>
  19
  20 <synopsis>
  21
  22 #include &lt;libglabels/str.h&gt;
  23
  24 <link linkend="gint">gint</link>                <link linkend="lgl-str-utf8-casecmp">lgl_str_utf8_casecmp</link>                (const <link linkend="gchar">gchar</link> *s1,
  25                                                          const <link linkend="gchar">gchar</link> *s2);
  26 </synopsis>
  27 </refsynopsisdiv>
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37 <refsect1 id="libglabels-str.description" role="desc">
  38 <title role="desc.title">Description</title>
  39 <para>
  40 This section defines string utility functions used by libglabels and of
  41 possible use to a user of libglabels.
  42 </para>
  43 </refsect1>
  44
  45 <refsect1 id="libglabels-str.details" role="details">
  46 <title role="details.title">Details</title>
  47 <refsect2 id="lgl-str-utf8-casecmp" role="function">
  48 <title>lgl_str_utf8_casecmp ()</title>
  49 <indexterm zone="lgl-str-utf8-casecmp"><primary sortas="lgl_str_utf8_casecmp">lgl_str_utf8_casecmp</primary></indexterm><programlisting><link linkend="gint">gint</link>                lgl_str_utf8_casecmp                (const <link linkend="gchar">gchar</link> *s1,
  50                                                          const <link linkend="gchar">gchar</link> *s2);</programlisting>
  51 <para>
  52 Compare two UTF-8 strings, ignoring the case of characters.
  53 </para>
  54 <para>
  55 This function should be used only on strings that are known to be encoded
  56 in UTF-8 or a compatible UTF-8 subset.</para>
  57 <para>
  58 </para><variablelist role="params">
  59 <varlistentry><term><parameter>s1</parameter>&#160;:</term>
  60 <listitem><simpara> string to compare with s2.
  61 </simpara></listitem></varlistentry>
  62 <varlistentry><term><parameter>s2</parameter>&#160;:</term>
  63 <listitem><simpara> string to compare with s1.
  64 </simpara></listitem></varlistentry>
  65 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 if the strings match, a negative value if s1 &lt; s2,
  66          or a positive value if s1 &gt; s2.
  67
  68 </simpara></listitem></varlistentry>
  69 </variablelist></refsect2>
  70
  71 </refsect1>
  72
  73
  74
  75
  76 </refentry>