doc/devhelp/libxml2-xmlstring.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <html>
   3   <head>
   4     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
   5     <title>xmlstring: set of routines to process strings</title>
   6     <meta name="generator" content="Libxml2 devhelp stylesheet"/>
   7     <link rel="start" href="index.html" title="libxml2 Reference Manual"/>
   8     <link rel="up" href="general.html" title="API"/>
   9     <link rel="stylesheet" href="style.css" type="text/css"/>
  10     <link rel="chapter" href="general.html" title="API"/>
  11   </head>
  12   <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13     <table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  14       <tr valign="middle">
  15         <td>
  16           <a accesskey="p" href="libxml2-xmlschemastypes.html">
  17             <img src="left.png" width="24" height="24" border="0" alt="Prev"/>
  18           </a>
  19         </td>
  20         <td>
  21           <a accesskey="u" href="general.html">
  22             <img src="up.png" width="24" height="24" border="0" alt="Up"/>
  23           </a>
  24         </td>
  25         <td>
  26           <a accesskey="h" href="index.html">
  27             <img src="home.png" width="24" height="24" border="0" alt="Home"/>
  28           </a>
  29         </td>
  30         <td>
  31           <a accesskey="n" href="libxml2-xmlunicode.html">
  32             <img src="right.png" width="24" height="24" border="0" alt="Next"/>
  33           </a>
  34         </td>
  35         <th width="100%" align="center">libxml2 Reference Manual</th>
  36       </tr>
  37     </table>
  38     <h2>
  39       <span class="refentrytitle">xmlstring</span>
  40     </h2>
  41     <p>xmlstring - set of routines to process strings</p>
  42     <p>type and interfaces needed for the internal string handling of the library, especially UTF8 processing. </p>
  43     <p>Author(s): Daniel Veillard </p>
  44     <div class="refsynopsisdiv">
  45       <h2>Synopsis</h2>
  46       <pre class="synopsis">#define <a href="#BAD_CAST">BAD_CAST</a>;
  47 typedef unsigned char <a href="#xmlChar">xmlChar</a>;
  48 int     <a href="#xmlStrcmp">xmlStrcmp</a>                      (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2);
  49 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlCharStrndup">xmlCharStrndup</a>            (const char * cur, <br/>                                         int len);
  50 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    <a href="#xmlStrcasestr">xmlStrcasestr</a>              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br/>                                         const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * val);
  51 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlStrcat">xmlStrcat</a>              (<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * add);
  52 int     <a href="#xmlStrPrintf">xmlStrPrintf</a>                        (<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * buf, <br/>                                       int len, <br/>                                  const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * msg, <br/>                                         ... ...);
  53 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    <a href="#xmlStrstr">xmlStrstr</a>              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br/>                                         const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * val);
  54 int     <a href="#xmlUTF8Size">xmlUTF8Size</a>                  (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf);
  55 int     <a href="#xmlStrQEqual">xmlStrQEqual</a>                        (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * pref, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str);
  56 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlStrncatNew">xmlStrncatNew</a>              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2, <br/>                                        int len);
  57 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    <a href="#xmlUTF8Strpos">xmlUTF8Strpos</a>              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         int pos);
  58 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlStrdup">xmlStrdup</a>              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur);
  59 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlCharStrdup">xmlCharStrdup</a>              (const char * cur);
  60 const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    <a href="#xmlStrchr">xmlStrchr</a>              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br/>                                         <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> val);
  61 int     <a href="#xmlStrlen">xmlStrlen</a>                      (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str);
  62 int     <a href="#xmlStrncmp">xmlStrncmp</a>                    (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2, <br/>                                        int len);
  63 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlStrsub">xmlStrsub</a>              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br/>                                         int start, <br/>                                        int len);
  64 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlStrncat">xmlStrncat</a>            (<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * add, <br/>                                         int len);
  65 int     <a href="#xmlGetUTF8Char">xmlGetUTF8Char</a>                    (const unsigned char * utf, <br/>                                        int * len);
  66 int     <a href="#xmlStrcasecmp">xmlStrcasecmp</a>                      (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2);
  67 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlStrndup">xmlStrndup</a>            (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur, <br/>                                         int len);
  68 int     <a href="#xmlStrVPrintf">xmlStrVPrintf</a>                      (<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * buf, <br/>                                       int len, <br/>                                  const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * msg, <br/>                                         va_list ap);
  69 int     <a href="#xmlUTF8Strsize">xmlUTF8Strsize</a>                    (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         int len);
  70 int     <a href="#xmlCheckUTF8">xmlCheckUTF8</a>                        (const unsigned char * utf);
  71 int     <a href="#xmlStrncasecmp">xmlStrncasecmp</a>                    (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2, <br/>                                        int len);
  72 int     <a href="#xmlUTF8Strlen">xmlUTF8Strlen</a>                      (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf);
  73 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlUTF8Strsub">xmlUTF8Strsub</a>              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         int start, <br/>                                        int len);
  74 int     <a href="#xmlStrEqual">xmlStrEqual</a>                  (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2);
  75 int     <a href="#xmlUTF8Charcmp">xmlUTF8Charcmp</a>                    (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf2);
  76 <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  <a href="#xmlUTF8Strndup">xmlUTF8Strndup</a>            (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         int len);
  77 int     <a href="#xmlUTF8Strloc">xmlUTF8Strloc</a>                      (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utfchar);
  78 </pre>
  79     </div>
  80     <div class="refsect1" lang="en">
  81       <h2>Description</h2>
  82     </div>
  83     <div class="refsect1" lang="en">
  84       <h2>Details</h2>
  85       <div class="refsect2" lang="en">
  86         <div class="refsect2" lang="en"><h3><a name="BAD_CAST">Macro </a>BAD_CAST</h3><pre class="programlisting">#define <a href="#BAD_CAST">BAD_CAST</a>;
  87 </pre><p>Macro to cast a string to an <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * when one know its safe.</p>
  88 </div>
  89         <hr/>
  90         <div class="refsect2" lang="en"><h3><a name="xmlChar">Typedef </a>xmlChar</h3><pre class="programlisting">unsigned char xmlChar;
  91 </pre><p>This is a basic byte in an UTF-8 encoded string. It's unsigned allowing to pinpoint case where char * are assigned to <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * (possibly making serialization back impossible).</p>
  92 </div>
  93         <hr/>
  94         <div class="refsect2" lang="en"><h3><a name="xmlCharStrdup"/>xmlCharStrdup ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    xmlCharStrdup           (const char * cur)<br/>
  95 </pre><p>a strdup for char's to xmlChar's</p>
  96 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>cur</tt></i>:</span></td><td>the input char *</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * or NULL</td></tr></tbody></table></div></div>
  97         <hr/>
  98         <div class="refsect2" lang="en"><h3><a name="xmlCharStrndup"/>xmlCharStrndup ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  xmlCharStrndup          (const char * cur, <br/>                                         int len)<br/>
  99 </pre><p>a strndup for char's to xmlChar's</p>
 100 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>cur</tt></i>:</span></td><td>the input char *</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the len of @cur</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * or NULL</td></tr></tbody></table></div></div>
 101         <hr/>
 102         <div class="refsect2" lang="en"><h3><a name="xmlCheckUTF8"/>xmlCheckUTF8 ()</h3><pre class="programlisting">int xmlCheckUTF8                    (const unsigned char * utf)<br/>
 103 </pre><p>Checks @utf for being valid UTF-8. @utf is assumed to be null-terminated. This function is not super-strict, as it will allow longer UTF-8 sequences than necessary. Note that Java is capable of producing these sequences if provoked. Also note, this routine checks for the 4-byte maximum size, but does not check for 0x10ffff maximum value.</p>
 104 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>Pointer to putative UTF-8 encoded string.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>value: true if @utf is valid.</td></tr></tbody></table></div></div>
 105         <hr/>
 106         <div class="refsect2" lang="en"><h3><a name="xmlGetUTF8Char"/>xmlGetUTF8Char ()</h3><pre class="programlisting">int     xmlGetUTF8Char                  (const unsigned char * utf, <br/>                                        int * len)<br/>
 107 </pre><p>Read the first UTF8 character from @utf</p>
 108 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>a sequence of UTF-8 encoded bytes</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>a pointer to the minimum number of bytes present in the sequence. This is used to assure the next character is completely contained within the sequence.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the char value or -1 in case of error, and sets *len to the actual number of bytes consumed (0 in case of error)</td></tr></tbody></table></div></div>
 109         <hr/>
 110         <div class="refsect2" lang="en"><h3><a name="xmlStrEqual"/>xmlStrEqual ()</h3><pre class="programlisting">int   xmlStrEqual                     (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2)<br/>
 111 </pre><p>Check if both strings are equal of have same content. Should be a bit more readable and faster than xmlStrcmp()</p>
 112 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str1</tt></i>:</span></td><td>the first <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>str2</tt></i>:</span></td><td>the second <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>1 if they are equal, 0 if they are different</td></tr></tbody></table></div></div>
 113         <hr/>
 114         <div class="refsect2" lang="en"><h3><a name="xmlStrPrintf"/>xmlStrPrintf ()</h3><pre class="programlisting">int xmlStrPrintf                    (<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * buf, <br/>                                       int len, <br/>                                  const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * msg, <br/>                                         ... ...)<br/>
 115 </pre><p>Formats @msg and places result into @buf.</p>
 116 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>the result buffer.</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the result buffer length.</td></tr><tr><td><span class="term"><i><tt>msg</tt></i>:</span></td><td>the message with printf formatting.</td></tr><tr><td><span class="term"><i><tt>...</tt></i>:</span></td><td>extra parameters for the message.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of <a href="libxml2-SAX.html#characters">characters</a> written to @buf or -1 if an error occurs.</td></tr></tbody></table></div></div>
 117         <hr/>
 118         <div class="refsect2" lang="en"><h3><a name="xmlStrQEqual"/>xmlStrQEqual ()</h3><pre class="programlisting">int xmlStrQEqual                    (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * pref, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str)<br/>
 119 </pre><p>Check if a QName is Equal to a given string</p>
 120 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pref</tt></i>:</span></td><td>the prefix of the QName</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the localname of the QName</td></tr><tr><td><span class="term"><i><tt>str</tt></i>:</span></td><td>the second <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>1 if they are equal, 0 if they are different</td></tr></tbody></table></div></div>
 121         <hr/>
 122         <div class="refsect2" lang="en"><h3><a name="xmlStrVPrintf"/>xmlStrVPrintf ()</h3><pre class="programlisting">int       xmlStrVPrintf                   (<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * buf, <br/>                                       int len, <br/>                                  const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * msg, <br/>                                         va_list ap)<br/>
 123 </pre><p>Formats @msg and places result into @buf.</p>
 124 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>the result buffer.</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the result buffer length.</td></tr><tr><td><span class="term"><i><tt>msg</tt></i>:</span></td><td>the message with printf formatting.</td></tr><tr><td><span class="term"><i><tt>ap</tt></i>:</span></td><td>extra parameters for the message.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of <a href="libxml2-SAX.html#characters">characters</a> written to @buf or -1 if an error occurs.</td></tr></tbody></table></div></div>
 125         <hr/>
 126         <div class="refsect2" lang="en"><h3><a name="xmlStrcasecmp"/>xmlStrcasecmp ()</h3><pre class="programlisting">int       xmlStrcasecmp                   (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2)<br/>
 127 </pre><p>a strcasecmp for xmlChar's</p>
 128 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str1</tt></i>:</span></td><td>the first <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>str2</tt></i>:</span></td><td>the second <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the integer result of the comparison</td></tr></tbody></table></div></div>
 129         <hr/>
 130         <div class="refsect2" lang="en"><h3><a name="xmlStrcasestr"/>xmlStrcasestr ()</h3><pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *      xmlStrcasestr           (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br/>                                         const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * val)<br/>
 131 </pre><p>a case-ignoring strstr for xmlChar's</p>
 132 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array (haystack)</td></tr><tr><td><span class="term"><i><tt>val</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> to search (needle)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * for the first occurrence or NULL.</td></tr></tbody></table></div></div>
 133         <hr/>
 134         <div class="refsect2" lang="en"><h3><a name="xmlStrcat"/>xmlStrcat ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    xmlStrcat               (<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * add)<br/>
 135 </pre><p>a strcat for array of xmlChar's. Since they are supposed to be encoded in UTF-8 or an encoding with 8bit based chars, we assume a termination mark of '0'.</p>
 136 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>cur</tt></i>:</span></td><td>the original <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array</td></tr><tr><td><span class="term"><i><tt>add</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array added</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * containing the concatenated string.</td></tr></tbody></table></div></div>
 137         <hr/>
 138         <div class="refsect2" lang="en"><h3><a name="xmlStrchr"/>xmlStrchr ()</h3><pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *      xmlStrchr               (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br/>                                         <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> val)<br/>
 139 </pre><p>a strchr for xmlChar's</p>
 140 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array</td></tr><tr><td><span class="term"><i><tt>val</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> to search</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * for the first occurrence or NULL.</td></tr></tbody></table></div></div>
 141         <hr/>
 142         <div class="refsect2" lang="en"><h3><a name="xmlStrcmp"/>xmlStrcmp ()</h3><pre class="programlisting">int       xmlStrcmp                       (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2)<br/>
 143 </pre><p>a strcmp for xmlChar's</p>
 144 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str1</tt></i>:</span></td><td>the first <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>str2</tt></i>:</span></td><td>the second <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the integer result of the comparison</td></tr></tbody></table></div></div>
 145         <hr/>
 146         <div class="refsect2" lang="en"><h3><a name="xmlStrdup"/>xmlStrdup ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    xmlStrdup               (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur)<br/>
 147 </pre><p>a strdup for array of xmlChar's. Since they are supposed to be encoded in UTF-8 or an encoding with 8bit based chars, we assume a termination mark of '0'.</p>
 148 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>cur</tt></i>:</span></td><td>the input <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * or NULL</td></tr></tbody></table></div></div>
 149         <hr/>
 150         <div class="refsect2" lang="en"><h3><a name="xmlStrlen"/>xmlStrlen ()</h3><pre class="programlisting">int       xmlStrlen                       (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str)<br/>
 151 </pre><p>length of a xmlChar's string</p>
 152 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> contained in the ARRAY.</td></tr></tbody></table></div></div>
 153         <hr/>
 154         <div class="refsect2" lang="en"><h3><a name="xmlStrncasecmp"/>xmlStrncasecmp ()</h3><pre class="programlisting">int     xmlStrncasecmp                  (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2, <br/>                                        int len)<br/>
 155 </pre><p>a strncasecmp for xmlChar's</p>
 156 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str1</tt></i>:</span></td><td>the first <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>str2</tt></i>:</span></td><td>the second <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the max comparison length</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the integer result of the comparison</td></tr></tbody></table></div></div>
 157         <hr/>
 158         <div class="refsect2" lang="en"><h3><a name="xmlStrncat"/>xmlStrncat ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  xmlStrncat              (<a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur, <br/>                                       const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * add, <br/>                                         int len)<br/>
 159 </pre><p>a strncat for array of xmlChar's, it will extend @cur with the len first bytes of @add. Note that if @len &lt; 0 then this is an API error and NULL will be returned.</p>
 160 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>cur</tt></i>:</span></td><td>the original <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array</td></tr><tr><td><span class="term"><i><tt>add</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array added</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the length of @add</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *, the original @cur is reallocated if needed and should not be freed</td></tr></tbody></table></div></div>
 161         <hr/>
 162         <div class="refsect2" lang="en"><h3><a name="xmlStrncatNew"/>xmlStrncatNew ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    xmlStrncatNew           (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2, <br/>                                        int len)<br/>
 163 </pre><p>same as xmlStrncat, but creates a new string. The original two strings are not freed. If @len is &lt; 0 then the length will be calculated automatically.</p>
 164 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str1</tt></i>:</span></td><td>first <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> string</td></tr><tr><td><span class="term"><i><tt>str2</tt></i>:</span></td><td>second <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> string</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the len of @str2 or &lt; 0</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * or NULL</td></tr></tbody></table></div></div>
 165         <hr/>
 166         <div class="refsect2" lang="en"><h3><a name="xmlStrncmp"/>xmlStrncmp ()</h3><pre class="programlisting">int     xmlStrncmp                      (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str2, <br/>                                        int len)<br/>
 167 </pre><p>a strncmp for xmlChar's</p>
 168 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str1</tt></i>:</span></td><td>the first <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>str2</tt></i>:</span></td><td>the second <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the max comparison length</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the integer result of the comparison</td></tr></tbody></table></div></div>
 169         <hr/>
 170         <div class="refsect2" lang="en"><h3><a name="xmlStrndup"/>xmlStrndup ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  xmlStrndup              (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * cur, <br/>                                         int len)<br/>
 171 </pre><p>a strndup for array of xmlChar's</p>
 172 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>cur</tt></i>:</span></td><td>the input <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the len of @cur</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * or NULL</td></tr></tbody></table></div></div>
 173         <hr/>
 174         <div class="refsect2" lang="en"><h3><a name="xmlStrstr"/>xmlStrstr ()</h3><pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *      xmlStrstr               (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br/>                                         const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * val)<br/>
 175 </pre><p>a strstr for xmlChar's</p>
 176 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array (haystack)</td></tr><tr><td><span class="term"><i><tt>val</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> to search (needle)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * for the first occurrence or NULL.</td></tr></tbody></table></div></div>
 177         <hr/>
 178         <div class="refsect2" lang="en"><h3><a name="xmlStrsub"/>xmlStrsub ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    xmlStrsub               (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str, <br/>                                         int start, <br/>                                        int len)<br/>
 179 </pre><p>Extract a substring of a given string</p>
 180 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>str</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * array (haystack)</td></tr><tr><td><span class="term"><i><tt>start</tt></i>:</span></td><td>the index of the first char (zero based)</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the length of the substring</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * for the first occurrence or NULL.</td></tr></tbody></table></div></div>
 181         <hr/>
 182         <div class="refsect2" lang="en"><h3><a name="xmlUTF8Charcmp"/>xmlUTF8Charcmp ()</h3><pre class="programlisting">int     xmlUTF8Charcmp                  (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf1, <br/>                                        const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf2)<br/>
 183 </pre><p>compares the two UCS4 values</p>
 184 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf1</tt></i>:</span></td><td>pointer to first UTF8 char</td></tr><tr><td><span class="term"><i><tt>utf2</tt></i>:</span></td><td>pointer to second UTF8 char</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>result of the compare as with <a href="libxml2-xmlstring.html#xmlStrncmp">xmlStrncmp</a></td></tr></tbody></table></div></div>
 185         <hr/>
 186         <div class="refsect2" lang="en"><h3><a name="xmlUTF8Size"/>xmlUTF8Size ()</h3><pre class="programlisting">int   xmlUTF8Size                     (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf)<br/>
 187 </pre><p>calculates the internal size of a UTF8 character</p>
 188 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>pointer to the UTF8 character</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the numbers of bytes in the character, -1 on format error</td></tr></tbody></table></div></div>
 189         <hr/>
 190         <div class="refsect2" lang="en"><h3><a name="xmlUTF8Strlen"/>xmlUTF8Strlen ()</h3><pre class="programlisting">int       xmlUTF8Strlen                   (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf)<br/>
 191 </pre><p>compute the length of an UTF8 string, it doesn't do a full UTF8 checking of the content of the string.</p>
 192 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>a sequence of UTF-8 encoded bytes</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of <a href="libxml2-SAX.html#characters">characters</a> in the string or -1 in case of error</td></tr></tbody></table></div></div>
 193         <hr/>
 194         <div class="refsect2" lang="en"><h3><a name="xmlUTF8Strloc"/>xmlUTF8Strloc ()</h3><pre class="programlisting">int       xmlUTF8Strloc                   (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utfchar)<br/>
 195 </pre><p>a function to provide the relative location of a UTF8 char</p>
 196 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>the input UTF8 *</td></tr><tr><td><span class="term"><i><tt>utfchar</tt></i>:</span></td><td>the UTF8 character to be found</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the relative character position of the desired char or -1 if not found</td></tr></tbody></table></div></div>
 197         <hr/>
 198         <div class="refsect2" lang="en"><h3><a name="xmlUTF8Strndup"/>xmlUTF8Strndup ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *  xmlUTF8Strndup          (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         int len)<br/>
 199 </pre><p>a strndup for array of UTF8's</p>
 200 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>the input UTF8 *</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the len of @utf (in chars)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new UTF8 * or NULL</td></tr></tbody></table></div></div>
 201         <hr/>
 202         <div class="refsect2" lang="en"><h3><a name="xmlUTF8Strpos"/>xmlUTF8Strpos ()</h3><pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *      xmlUTF8Strpos           (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         int pos)<br/>
 203 </pre><p>a function to provide the equivalent of fetching a character from a string array</p>
 204 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>the input UTF8 *</td></tr><tr><td><span class="term"><i><tt>pos</tt></i>:</span></td><td>the position of the desired UTF8 char (in chars)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the UTF8 character or NULL</td></tr></tbody></table></div></div>
 205         <hr/>
 206         <div class="refsect2" lang="en"><h3><a name="xmlUTF8Strsize"/>xmlUTF8Strsize ()</h3><pre class="programlisting">int     xmlUTF8Strsize                  (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         int len)<br/>
 207 </pre><p>storage size of an UTF8 string the behaviour is not garanteed if the input string is not UTF-8</p>
 208 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>a sequence of UTF-8 encoded bytes</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>the number of <a href="libxml2-SAX.html#characters">characters</a> in the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage size of the first 'len' <a href="libxml2-SAX.html#characters">characters</a> of ARRAY</td></tr></tbody></table></div></div>
 209         <hr/>
 210         <div class="refsect2" lang="en"><h3><a name="xmlUTF8Strsub"/>xmlUTF8Strsub ()</h3><pre class="programlisting"><a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *    xmlUTF8Strsub           (const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * utf, <br/>                                         int start, <br/>                                        int len)<br/>
 211 </pre><p>Create a substring from a given UTF-8 string Note: positions are given in units of UTF-8 chars</p>
 212 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>utf</tt></i>:</span></td><td>a sequence of UTF-8 encoded bytes</td></tr><tr><td><span class="term"><i><tt>start</tt></i>:</span></td><td>relative pos of first char</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>total number to copy</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to a newly created string or NULL if any problem</td></tr></tbody></table></div></div>
 213         <hr/>
 214       </div>
 215     </div>
 216   </body>
 217 </html>