<html> <head> <title>Global Functions in Namespace in Sourcefile string.h</title> <link rel="stylesheet" type="text/css" href="../cpp.css"> </head> <body> <div id="adc-cppref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0"> <tr align="center" valign="top"> <td class="navimain"> <a href="../index.html">Overview</a> </td> <td class="navimain"> <a href="index.html">Namespace</a> </td> <td class="navimainnone"> Class </td> <td class="navimain"> <a href="../index-files/index-1.html">Index</a> </td> <td class="navimain"> <a href="../help.html">Help</a> </td> </tr> </table> <table class="navisub" cellpadding="0" cellspacing="3"></table> <hr> <div class="title"><h2>Global Functions in Global Namespace C++<br> in Sourcefile string.h</h2> </div><hr> <dl class="member"> <dt class="member"><a name="rtl_convertUStringToString-1556"> </a>rtl_convertUStringToString</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Bool.html">sal_Bool</a> <strong>rtl_convertUStringToString</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> pTarget,</td> </tr> <tr> <td>const <a href="t-sal_Unicode.html">sal_Unicode</a> *</td> <td>pSource,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>nLength,</td> </tr> <tr> <td><a href="t-rtl_TextEncoding.html">rtl_TextEncoding</a></td> <td>nEncoding,</td> </tr> <tr> <td><a href="t-sal_uInt32.html">sal_uInt32</a></td> <td>nFlags );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Converts a Unicode string to a byte string, signalling failure. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pTarget</td> <td><pre> An out parameter receiving the converted string. Must not be null itself, and must contain either null or a pointer to a valid rtl_String; the contents are not modified if conversion fails (rtl_convertUStringToString returns false). </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">pSource</td> <td><pre> The Unicode string. May only be null if nLength is zero. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">nLength</td> <td><pre> The length of the Unicode string. Must be non-negative. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">nEncoding</td> <td><pre> The text encoding to convert into. Must be an octet encoding (i.e., rtl_isOctetTextEncoding(nEncoding) must return true). </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">nFlags</td> <td><pre> A combination of RTL_UNICODETOTEXT_FLAGS that detail how to do the conversion (see rtl_convertUnicodeToText). RTL_UNICODETOTEXT_FLAGS_FLUSH need not be included, it is implicitly assumed. Typical uses are either RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR | RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR (fail if a Unicode character cannot be converted to the target nEncoding) or OUSTRING_TO_OSTRING_CVTFLAGS (make a best efforts conversion). </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> True if the conversion succeeded, false otherwise. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_compare-1497"> </a>rtl_str_compare</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_compare</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> first,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>second );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Compare two strings. </dd> <dt>Description</dt> <dd> The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting. Both strings must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">first</td> <td><pre> the first null-terminated string to be compared. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">second</td> <td><pre> the second null-terminated string which is compared with the first one. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> 0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_compareIgnoreAsciiCase-1501"> </a>rtl_str_compareIgnoreAsciiCase</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_compareIgnoreAsciiCase</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> first,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>second );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Compare two strings, ignoring the case of ASCII characters. </dd> <dt>Description</dt> <dd> The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 and 122 (ASCII a--z). This function cannot be used for language-specific sorting. Both strings must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">first</td> <td><pre> the first null-terminated string to be compared. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">second</td> <td><pre> the second null-terminated string which is compared with the first one. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> 0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_compareIgnoreAsciiCase_WithLength-1502"> </a>rtl_str_compareIgnoreAsciiCase_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_compareIgnoreAsciiCase_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> first,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>firstLen,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>second,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>secondLen );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Compare two strings, ignoring the case of ASCII characters. </dd> <dt>Description</dt> <dd> The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 and 122 (ASCII a--z). This function cannot be used for language-specific sorting. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">first</td> <td><pre> the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">firstLen</td> <td><pre> the length of the first string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">second</td> <td><pre> the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">secondLen</td> <td><pre> the length of the second string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> 0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_compare_WithLength-1498"> </a>rtl_str_compare_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_compare_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> first,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>firstLen,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>second,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>secondLen );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Compare two strings. </dd> <dt>Description</dt> <dd> The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">first</td> <td><pre> the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">firstLen</td> <td><pre> the length of the first string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">second</td> <td><pre> the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">secondLen</td> <td><pre> the length of the second string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> 0 if both strings are equal, a value less than 0 if the first string is less than the second string, and a value greater than 0 if the first string is greater than the second string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_getLength-1496"> </a>rtl_str_getLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_getLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Return the length of a string. </dd> <dt>Description</dt> <dd> The length is equal to the number of 8-bit characters in the string, without the terminating NUL character. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the length of the sequence of characters represented by this string, excluding the terminating NUL character. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_hashCode-1504"> </a>rtl_str_hashCode</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_hashCode</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Return a hash code for a string. </dd> <dt>Description</dt> <dd> It is not allowed to store the hash code persistently, because later versions could return other hash codes. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> a hash code for the given string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_hashCode_WithLength-1505"> </a>rtl_str_hashCode_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_hashCode_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Return a hash code for a string. </dd> <dt>Description</dt> <dd> It is not allowed to store the hash code persistently, because later versions could return other hash codes. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> a hash code for the given string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_indexOfChar-1506"> </a>rtl_str_indexOfChar</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_indexOfChar</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>ch );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Search for the first occurrence of a character within a string. </dd> <dt>Description</dt> <dd> The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">ch</td> <td><pre> the character to be searched for. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index (starting at 0) of the first occurrence of the character in the string, or -1 if the character does not occur. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_indexOfChar_WithLength-1507"> </a>rtl_str_indexOfChar_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_indexOfChar_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>ch );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Search for the first occurrence of a character within a string. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">ch</td> <td><pre> the character to be searched for. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index (starting at 0) of the first occurrence of the character in the string, or -1 if the character does not occur. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_indexOfStr-1510"> </a>rtl_str_indexOfStr</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_indexOfStr</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>subStr );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Search for the first occurrence of a substring within a string. </dd> <dt>Description</dt> <dd> If subStr is empty, or both str and subStr are empty, -1 is returned. Both strings must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">subStr</td> <td><pre> the null-terminated substring to be searched for. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index (starting at 0) of the first character of the first occurrence of the substring within the string, or -1 if the substring does not occur. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_indexOfStr_WithLength-1511"> </a>rtl_str_indexOfStr_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_indexOfStr_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>subStr,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>subLen );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Search for the first occurrence of a substring within a string. </dd> <dt>Description</dt> <dd> If subStr is empty, or both str and subStr are empty, -1 is returned. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">subStr</td> <td><pre> the substring to be searched for. Need not be null-terminated, but must be at least as long as the specified subLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">subLen</td> <td><pre> the length of the substring. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index (starting at 0) of the first character of the first occurrence of the substring within the string, or -1 if the substring does not occur. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_lastIndexOfChar-1508"> </a>rtl_str_lastIndexOfChar</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_lastIndexOfChar</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>ch );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Search for the last occurrence of a character within a string. </dd> <dt>Description</dt> <dd> The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">ch</td> <td><pre> the character to be searched for. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index (starting at 0) of the last occurrence of the character in the string, or -1 if the character does not occur. The returned value is always smaller than the string length. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_lastIndexOfChar_WithLength-1509"> </a>rtl_str_lastIndexOfChar_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_lastIndexOfChar_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>ch );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Search for the last occurrence of a character within a string. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">ch</td> <td><pre> the character to be searched for. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index (starting at 0) of the last occurrence of the character in the string, or -1 if the character does not occur. The returned value is always smaller than the string length. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_lastIndexOfStr-1512"> </a>rtl_str_lastIndexOfStr</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_lastIndexOfStr</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>subStr );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Search for the last occurrence of a substring within a string. </dd> <dt>Description</dt> <dd> If subStr is empty, or both str and subStr are empty, -1 is returned. Both strings must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">subStr</td> <td><pre> the null-terminated substring to be searched for. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index (starting at 0) of the first character of the last occurrence of the substring within the string, or -1 if the substring does not occur. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_lastIndexOfStr_WithLength-1513"> </a>rtl_str_lastIndexOfStr_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_lastIndexOfStr_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>subStr,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>subLen );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Search for the last occurrence of a substring within a string. </dd> <dt>Description</dt> <dd> If subStr is empty, or both str and subStr are empty, -1 is returned. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">subStr</td> <td><pre> the substring to be searched for. Need not be null-terminated, but must be at least as long as the specified subLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">subLen</td> <td><pre> the length of the substring. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index (starting at 0) of the first character of the first occurrence of the substring within the string, or -1 if the substring does not occur. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_replaceChar-1514"> </a>rtl_str_replaceChar</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_str_replaceChar</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>oldChar,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>newChar );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Replace all occurrences of a single character within a string. </dd> <dt>Description</dt> <dd> If oldChar does not occur within str, then the string is not modified. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">oldChar</td> <td><pre> the old character. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newChar</td> <td><pre> the new character. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_replaceChar_WithLength-1515"> </a>rtl_str_replaceChar_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_str_replaceChar_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>oldChar,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>newChar );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Replace all occurrences of a single character within a string. </dd> <dt>Description</dt> <dd> If oldChar does not occur within str, then the string is not modified. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">oldChar</td> <td><pre> the old character. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newChar</td> <td><pre> the new character. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_reverseCompare_WithLength-1500"> </a>rtl_str_reverseCompare_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_reverseCompare_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> first,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>firstLen,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>second,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>secondLen );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Compare two strings from back to front. </dd> <dt>Description</dt> <dd> The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">first</td> <td><pre> the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">firstLen</td> <td><pre> the length of the first string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">second</td> <td><pre> the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">secondLen</td> <td><pre> the length of the second string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> 0 if both strings are equal, a value less than 0 if the first string compares less than the second string, and a value greater than 0 if the first string compares greater than the second string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_shortenedCompareIgnoreAsciiCase_WithLength-1503"> </a>rtl_str_shortenedCompareIgnoreAsciiCase_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_shortenedCompareIgnoreAsciiCase_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> first,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>firstLen,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>second,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>secondLen,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>shortenedLen );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Compare two strings with a maximum count of characters, ignoring the case of ASCII characters. </dd> <dt>Description</dt> <dd>The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. Character values between 65 and 90 (ASCII A--Z) are interpreted as values between 97 and 122 (ASCII a--z). This function cannot be used for language-specific sorting. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">first</td> <td><pre>the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">firstLen</td> <td><pre>the length of the first string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">second</td> <td><pre>the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">secondLen</td> <td><pre>the length of the second string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">shortenedLen</td> <td><pre>the maximum number of characters to compare. This length can be greater or smaller than the lengths of the two strings. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> 0 if both substrings are equal, a value less than 0 if the first substring is less than the second substring, and a value greater than 0 if the first substring is greater than the second substring. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_shortenedCompare_WithLength-1499"> </a>rtl_str_shortenedCompare_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_shortenedCompare_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> first,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>firstLen,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>second,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>secondLen,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>shortenedLen );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Compare two strings with a maximum count of characters. </dd> <dt>Description</dt> <dd> The comparison is based on the numeric value of each character in the strings and returns a value indicating their relationship. This function cannot be used for language-specific sorting. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">first</td> <td><pre> the first string to be compared. Need not be null-terminated, but must be at least as long as the specified firstLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">firstLen</td> <td><pre> the length of the first string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">second</td> <td><pre> the second string which is compared with the first one. Need not be null-terminated, but must be at least as long as the specified secondLen. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">secondLen</td> <td><pre> the length of the second string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">shortenedLen</td> <td><pre> the maximum number of characters to compare. This length can be greater or smaller than the lengths of the two strings. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> 0 if both substrings are equal, a value less than 0 if the first substring is less than the second substring, and a value greater than 0 if the first substring is greater than the second substring. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toAsciiLowerCase-1516"> </a>rtl_str_toAsciiLowerCase</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_str_toAsciiLowerCase</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Convert all ASCII uppercase letters to lowercase within a string. </dd> <dt>Description</dt> <dd> The characters with values between 65 and 90 (ASCII A--Z) are replaced with values between 97 and 122 (ASCII a--z). The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toAsciiLowerCase_WithLength-1517"> </a>rtl_str_toAsciiLowerCase_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_str_toAsciiLowerCase_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Convert all ASCII uppercase letters to lowercase within a string. </dd> <dt>Description</dt> <dd> The characters with values between 65 and 90 (ASCII A--Z) are replaced with values between 97 and 122 (ASCII a--z). </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toAsciiUpperCase-1518"> </a>rtl_str_toAsciiUpperCase</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_str_toAsciiUpperCase</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Convert all ASCII lowercase letters to uppercase within a string. </dd> <dt>Description</dt> <dd> The characters with values between 97 and 122 (ASCII a--z) are replaced with values between 65 and 90 (ASCII A--Z). The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toAsciiUpperCase_WithLength-1519"> </a>rtl_str_toAsciiUpperCase_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_str_toAsciiUpperCase_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Convert all ASCII lowercase letters to uppercase within a string. </dd> <dt>Description</dt> <dd> The characters with values between 97 and 122 (ASCII a--z) are replaced with values between 65 and 90 (ASCII A--Z). </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toBoolean-1528"> </a>rtl_str_toBoolean</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Bool.html">sal_Bool</a> <strong>rtl_str_toBoolean</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Interpret a string as a boolean. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific conversion. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> true if the string is "1" or "true" in any ASCII case, false otherwise. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toDouble-1532"> </a>rtl_str_toDouble</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> double <strong>rtl_str_toDouble</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Interpret a string as a double. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific conversion. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the float value represented by the string, or 0.0 if the string does not represent a double. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toFloat-1531"> </a>rtl_str_toFloat</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> float <strong>rtl_str_toFloat</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Interpret a string as a float. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific conversion. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the float value represented by the string, or 0.0 if the string does not represent a float. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toInt32-1529"> </a>rtl_str_toInt32</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_toInt32</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int16.html">sal_Int16</a></td> <td>radix );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Interpret a string as an integer. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific conversion. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">radix</td> <td><pre> the radix. Must be between RTL_STR_MIN_RADIX (2) and RTL_STR_MAX_RADIX (36), inclusive. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the integer value represented by the string, or 0 if the string does not represent an integer. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_toInt64-1530"> </a>rtl_str_toInt64</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int64.html">sal_Int64</a> <strong>rtl_str_toInt64</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int16.html">sal_Int16</a></td> <td>radix );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Interpret a string as a long integer. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific conversion. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">radix</td> <td><pre> the radix. Must be between RTL_STR_MIN_RADIX (2) and RTL_STR_MAX_RADIX (36), inclusive. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the long integer value represented by the string, or 0 if the string does not represent a long integer. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_trim-1520"> </a>rtl_str_trim</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_trim</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Remove white space from both ends of a string. </dd> <dt>Description</dt> <dd> All characters with values less than or equal to 32 (the space character) are considered to be white space. This function cannot be used for language-specific operations. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a null-terminated string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the new length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_trim_WithLength-1521"> </a>rtl_str_trim_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_trim_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Remove white space from both ends of the string. </dd> <dt>Description</dt> <dd> All characters with values less than or equal to 32 (the space character) are considered to be white space. This function cannot be used for language-specific operations. The string must be null-terminated. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the original length of the string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the new length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_valueOfBoolean-1522"> </a>rtl_str_valueOfBoolean</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_valueOfBoolean</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Bool.html">sal_Bool</a></td> <td>b );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create the string representation of a boolean. </dd> <dt>Description</dt> <dd> If b is true, the buffer is filled with the string "true" and 5 is returned. If b is false, the buffer is filled with the string "false" and 6 is returned. This function cannot be used for language-specific operations. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_STR_MAX_VALUEOFBOOLEAN define to create a buffer that is big enough. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">b</td> <td><pre> a boolean value. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_valueOfChar-1523"> </a>rtl_str_valueOfChar</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_valueOfChar</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>ch );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create the string representation of a character. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_STR_MAX_VALUEOFCHAR define to create a buffer that is big enough. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">ch</td> <td><pre> a character value. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_valueOfDouble-1527"> </a>rtl_str_valueOfDouble</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_valueOfDouble</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td>double</td> <td>d );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create the string representation of a double. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific conversion. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_STR_MAX_VALUEOFDOUBLE define to create a buffer that is big enough. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">d</td> <td><pre> a double value. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_valueOfFloat-1526"> </a>rtl_str_valueOfFloat</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_valueOfFloat</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td>float</td> <td>f );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create the string representation of a float. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific conversion. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_STR_MAX_VALUEOFFLOAT define to create a buffer that is big enough. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">f</td> <td><pre> a float value. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_valueOfInt32-1524"> </a>rtl_str_valueOfInt32</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_valueOfInt32</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>i,</td> </tr> <tr> <td><a href="t-sal_Int16.html">sal_Int16</a></td> <td>radix );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create the string representation of an integer. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific operations. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_STR_MAX_VALUEOFINT32 define to create a buffer that is big enough. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">i</td> <td><pre> an integer value. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">radix</td> <td><pre> the radix. Must be between RTL_STR_MIN_RADIX (2) and RTL_STR_MAX_RADIX (36), inclusive. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_str_valueOfInt64-1525"> </a>rtl_str_valueOfInt64</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_str_valueOfInt64</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-sal_Char.html">sal_Char</a> * </td> <td> str,</td> </tr> <tr> <td><a href="t-sal_Int64.html">sal_Int64</a></td> <td>l,</td> </tr> <tr> <td><a href="t-sal_Int16.html">sal_Int16</a></td> <td>radix );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create the string representation of a long integer. </dd> <dt>Description</dt> <dd> This function cannot be used for language-specific operations. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a buffer that is big enough to hold the result and the terminating NUL character. You should use the RTL_STR_MAX_VALUEOFINT64 define to create a buffer that is big enough. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">l</td> <td><pre> a long integer value. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">radix</td> <td><pre> the radix. Must be between RTL_STR_MIN_RADIX (2) and RTL_STR_MAX_RADIX (36), inclusive. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_acquire-1538"> </a>rtl_string_acquire</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_acquire</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Increment the reference count of a string. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_assign-1545"> </a>rtl_string_assign</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_assign</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> str,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>rightValue );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Assign a new value to a string. </dd> <dt>Description</dt> <dd> First releases any value str might currently hold, then acquires rightValue. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> pointer to the string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">rightValue</td> <td><pre> a valid string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_getLength-1546"> </a>rtl_string_getLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_string_getLength</strong>(</dt> <dd><table class="param-table"> <tr> <td>const <a href="t-rtl_String.html">rtl_String</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Return the length of a string. </dd> <dt>Description</dt> <dd> The length is equal to the number of characters in the string. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a valid string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the length of the string. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_getStr-1547"> </a>rtl_string_getStr</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Char.html">sal_Char</a> * <strong>rtl_string_getStr</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Return a pointer to the underlying character array of a string. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a valid string. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> a pointer to the null-terminated character array. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_getToken-1554"> </a>rtl_string_getToken</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> <a href="t-sal_Int32.html">sal_Int32</a> <strong>rtl_string_getToken</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>token,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>cTok,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>idx );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create a new string by extracting a single token from another string. </dd> <dt>Description</dt> <dd> Starting at index, the token's next token is searched for. If there is no such token, the result is an empty string. Otherwise, all characters from the start of that token and up to, but not including the next occurrence of cTok make up the resulting token. The return value is the position of the next token, or -1 if no more tokens follow. Example code could look like rtl_String * pToken = NULL; sal_Int32 nIndex = 0; do { ... nIndex = rtl_string_getToken(&pToken, pStr, 0, ';', nIndex); ... } while (nIndex >= 0); The new string does not necessarily have a reference count of 1, so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre> pointer to the new string. The pointed-to data must be null or a valid string. If either token or index is negative, an empty token is stored in newStr (and -1 is returned). </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">token</td> <td><pre> the number of the token to return, starting at index. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">cTok</td> <td><pre> the character that seperates the tokens. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">index</td> <td><pre> the position at which searching for the token starts. Must not be greater than the length of str. </pre></td> </tr> </table> </dd> <dt>Return</dt> <dd> the index of the next token, or -1 if no more tokens follow. </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_new-1540"> </a>rtl_string_new</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_new</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Allocate a new string containing no characters. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre> pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newConcat-1548"> </a>rtl_string_newConcat</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newConcat</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>left,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>right );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create a new string that is the concatenation of two other strings. </dd> <dt>Description</dt> <dd> The new string does not necessarily have a reference count of 1 (in cases where one of the two other strings is empty), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre> pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">left</td> <td><pre> a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">right</td> <td><pre> a valid string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newFromStr-1543"> </a>rtl_string_newFromStr</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newFromStr</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>value );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Allocate a new string that contains a copy of a character array. </dd> <dt>Description</dt> <dd> If the length of value is greater than zero, the reference count of the new string will be 1. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre> pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">value</td> <td><pre> a null-terminated character array. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newFromStr_WithLength-1544"> </a>rtl_string_newFromStr_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newFromStr_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td>const <a href="t-sal_Char.html">sal_Char</a> *</td> <td>value,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Allocate a new string that contains a copy of a character array. </dd> <dt>Description</dt> <dd> If the length of value is greater than zero, the reference count of the new string will be 1. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre> pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">value</td> <td><pre> a character array. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the length of the character array. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newFromString-1542"> </a>rtl_string_newFromString</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newFromString</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td>const <a href="t-rtl_String.html">rtl_String</a> *</td> <td>value );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Allocate a new string that contains a copy of another string. </dd> <dt>Description</dt> <dd> If the length of value is greater than zero, the reference count of the new string will be 1. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre> pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">value</td> <td><pre> a valid string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newReplace-1550"> </a>rtl_string_newReplace</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newReplace</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>str,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>oldChar,</td> </tr> <tr> <td><a href="t-sal_Char.html">sal_Char</a></td> <td>newChar );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create a new string by replacing all occurrences of a single character within another string. </dd> <dt>Description</dt> <dd>The new string results from replacing all occurrences of oldChar in str with newChar. The new string does not necessarily have a reference count of 1 (in cases where oldChar does not occur in str), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre>pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre>a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">oldChar</td> <td><pre>the old character. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newChar</td> <td><pre>the new character. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newReplaceStrAt-1549"> </a>rtl_string_newReplaceStrAt</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newReplaceStrAt</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>idx,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>count,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>subStr );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create a new string by replacing a substring of another string. </dd> <dt>Description</dt> <dd> The new string results from replacing a number of characters (count), starting at the specified position (index) in the original string (str), with some new substring (subStr). If subStr is null, than only a number of characters is deleted. The new string does not necessarily have a reference count of 1, so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre> pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">index</td> <td><pre> the index into str at which to start replacement. Must be between 0 and the length of str, inclusive. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">count</td> <td><pre> the number of charcters to remove. Must not be negative, and the sum of index and count must not exceed the length of str. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">subStr</td> <td><pre> either null or a valid string to be inserted. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newToAsciiLowerCase-1551"> </a>rtl_string_newToAsciiLowerCase</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newToAsciiLowerCase</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create a new string by converting all ASCII uppercase letters to lowercase within another string. </dd> <dt>Description</dt> <dd>The new string results from replacing all characters with values between 65 and 90 (ASCII A--Z) by values between 97 and 122 (ASCII a--z). This function cannot be used for language-specific conversion. The new string does not necessarily have a reference count of 1 (in cases where no characters need to be converted), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre>pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre>a valid string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newToAsciiUpperCase-1552"> </a>rtl_string_newToAsciiUpperCase</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newToAsciiUpperCase</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create a new string by converting all ASCII lowercase letters to uppercase within another string. </dd> <dt>Description</dt> <dd>The new string results from replacing all characters with values between 97 and 122 (ASCII a--z) by values between 65 and 90 (ASCII A--Z). This function cannot be used for language-specific conversion. The new string does not necessarily have a reference count of 1 (in cases where no characters need to be converted), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre>pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre>a valid string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_newTrim-1553"> </a>rtl_string_newTrim</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_newTrim</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td><a href="t-rtl_String.html">rtl_String</a> *</td> <td>str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create a new string by removing white space from both ends of another string. </dd> <dt>Description</dt> <dd>The new string results from removing all characters with values less than or equal to 32 (the space character) form both ends of str. This function cannot be used for language-specific conversion. The new string does not necessarily have a reference count of 1 (in cases where no characters need to be removed), so it must not be modified without checking the reference count. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre>pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre>a valid string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_new_WithLength-1541"> </a>rtl_string_new_WithLength</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_new_WithLength</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Allocate a new string containing space for a given number of characters. </dd> <dt>Description</dt> <dd> If len is greater than zero, the reference count of the new string will be 1. The values of all characters are set to 0 and the length of the string is 0. This function does not handle out-of-memory conditions. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre> pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre> the number of characters. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_string_release-1539"> </a>rtl_string_release</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_string_release</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * </td> <td> str );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Decrement the reference count of a string. </dd> <dt>Description</dt> <dd> If the count goes to zero than the string data is deleted. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre> a string. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <dl class="member"> <dt class="member"><a name="rtl_uString2String-1555"> </a>rtl_uString2String</dt> <dd class="member"><dl> <dt class="simple">extern "C"<br> void <strong>rtl_uString2String</strong>(</dt> <dd><table class="param-table"> <tr> <td><a href="t-rtl_String.html">rtl_String</a> * * </td> <td> newStr,</td> </tr> <tr> <td>const <a href="t-sal_Unicode.html">sal_Unicode</a> *</td> <td>str,</td> </tr> <tr> <td><a href="t-sal_Int32.html">sal_Int32</a></td> <td>len,</td> </tr> <tr> <td><a href="t-rtl_TextEncoding.html">rtl_TextEncoding</a></td> <td>encoding,</td> </tr> <tr> <td><a href="t-sal_uInt32.html">sal_uInt32</a></td> <td>convertFlags );</td> </tr> </table> </dd> </dl> <br> </dd> <dd class="member"><table class="flag-table" border="1" cellspacing="0"> <tr> <td width="12%" class="flagname">virtual</td> <td width="12%" class="flagname">abstract</td> <td width="12%" class="flagname">const</td> <td width="12%" class="flagname">volatile</td> <td width="12%" class="flagname">template</td> <td width="12%" class="flagname">static</td> <td width="12%" class="flagname">inline</td> <td width="12%" class="flagname">C-linkage</td> </tr> <tr> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagno">NO</td> <td class="flagyes">YES</td> </tr> </table> <br> </dd> <dd class="member"><dl> <dt>Summary</dt> <dd>Create a new byte string by converting a Unicode string, using a specific text encoding. </dd> <dt>Description</dt> <dd>The lengths of the byte string and the Unicode string may differ (e.g., for double-byte encodings, UTF-7, UTF-8). If the length of the Unicode string is greater than zero, the reference count of the new string will be 1. If an out-of-memory condition occurs, newStr will point to a null pointer upon return. </dd> <dt>Parameters</dt> <dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table"> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">newStr</td> <td><pre>pointer to the new string. The pointed-to data must be null or a valid string. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">str</td> <td><pre>a Unicode character array. Need not be null-terminated, but must be at least as long as the specified len. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">len</td> <td><pre>the length of the Unicode character array. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">encoding</td> <td><pre>the text encoding to use for conversion. </pre></td> </tr> <tr> <td width="15%" style="vertical-align:top; font-weight:bold">convertFlags</td> <td><pre>flags which control the conversion. Either use OUSTRING_TO_OSTRING_CVTFLAGS, or see <http://udk.openoffice.org/cpp/man/spec/textconversion.html> for more details. </pre></td> </tr> </table> </dd> </dl> </dd> </dl> <hr> <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-cppref" --> </body> </html>