Accueil Explorer Aide
Connexion
TorqueEngine
/
Torque2D
miroir de https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: 6bcbc35cd1
Branches Tags
Torque2D
/
TorqueScriptDocs
/
html
/
group__StringFunctions.html

group__StringFunctions.html 34 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.10"/>
    7. 

  7. <title>TorqueScript Reference: String</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
    13. 

  13. </head>
    14. 

  14. <body>
    15. 

  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    16. 

  16. <div id="titlearea">
    17. 

  17. <table cellspacing="0" cellpadding="0">
    18. 

  18.  <tbody>
    19. 

  19.  <tr style="height: 56px;">
    20. 

  20.   <td id="projectalign" style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">TorqueScript Reference
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.10 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li><a href="annotated.html"><span>Classes</span></a></li>
    35. 

  35.     </ul>
    36. 

  36.   </div>
    37. 

  37. </div><!-- top -->
    38. 

  38. <div class="header">
    39. 

  39.   <div class="summary">
    40. 

  40. <a href="#func-members">Functions</a>  </div>
    41. 

  41.   <div class="headertitle">
    42. 

  42. <div class="title">String<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div>  </div>
    43. 

  43. </div><!--header-->
    44. 

  44. <div class="contents">
    45. 

  45. <table class="memberdecls">
    46. 

  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    47. 

  47. Functions</h2></td></tr>
    48. 

  48. <tr class="memitem:ga484bcb723e4d8bd6f7e6b362ccbdea27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga484bcb723e4d8bd6f7e6b362ccbdea27">getSubStr</a> (sourceString, start, count)</td></tr>
    49. 

  49. <tr class="separator:ga484bcb723e4d8bd6f7e6b362ccbdea27"><td class="memSeparator" colspan="2">&#160;</td></tr>
    50. 

  50. <tr class="memitem:ga398dd476c27e2270efec203fcead4f74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga398dd476c27e2270efec203fcead4f74">ltrim</a> (sourceString)</td></tr>
    51. 

  51. <tr class="separator:ga398dd476c27e2270efec203fcead4f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
    52. 

  52. <tr class="memitem:ga39d5c31d3f04fdd1687d2fcda5754136"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga39d5c31d3f04fdd1687d2fcda5754136">rtrim</a> (sourceString)</td></tr>
    53. 

  53. <tr class="separator:ga39d5c31d3f04fdd1687d2fcda5754136"><td class="memSeparator" colspan="2">&#160;</td></tr>
    54. 

  54. <tr class="memitem:ga44cf5b8b8bea66e935d51769da41d268"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga44cf5b8b8bea66e935d51769da41d268">strchr</a> (sourceString, char)</td></tr>
    55. 

  55. <tr class="separator:ga44cf5b8b8bea66e935d51769da41d268"><td class="memSeparator" colspan="2">&#160;</td></tr>
    56. 

  56. <tr class="memitem:gadd80e9144f64c2e3219a74be1198b4d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gadd80e9144f64c2e3219a74be1198b4d2">strcmp</a> (string1, string2)</td></tr>
    57. 

  57. <tr class="separator:gadd80e9144f64c2e3219a74be1198b4d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    58. 

  58. <tr class="memitem:gae26368e0921a917a0644f6f4c38ceeb7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gae26368e0921a917a0644f6f4c38ceeb7">stricmp</a> (string1, string2)</td></tr>
    59. 

  59. <tr class="separator:gae26368e0921a917a0644f6f4c38ceeb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    60. 

  60. <tr class="memitem:ga6732ae030c5401ac4df1568df612e6a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga6732ae030c5401ac4df1568df612e6a0">stripChars</a> (sourceString, chars)</td></tr>
    61. 

  61. <tr class="separator:ga6732ae030c5401ac4df1568df612e6a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
    62. 

  62. <tr class="memitem:ga8146a7417e5547eb8218351806454ed3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga8146a7417e5547eb8218351806454ed3">stripColorCodes</a> (stringtoStrip)</td></tr>
    63. 

  63. <tr class="separator:ga8146a7417e5547eb8218351806454ed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    64. 

  64. <tr class="memitem:gaa0f0826c103e5d3da9790db75545ce11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a> (string)</td></tr>
    65. 

  65. <tr class="separator:gaa0f0826c103e5d3da9790db75545ce11"><td class="memSeparator" colspan="2">&#160;</td></tr>
    66. 

  66. <tr class="memitem:gadebd1409d216aaa04765a5c45f4d433d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gadebd1409d216aaa04765a5c45f4d433d">strlen</a> (string)</td></tr>
    67. 

  67. <tr class="separator:gadebd1409d216aaa04765a5c45f4d433d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    68. 

  68. <tr class="memitem:ga4ca39bba5a20c2b54cbf832c86825b9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga4ca39bba5a20c2b54cbf832c86825b9f">strlwr</a> (sourceString)</td></tr>
    69. 

  69. <tr class="separator:ga4ca39bba5a20c2b54cbf832c86825b9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    70. 

  70. <tr class="memitem:gaea95ea452d0f17de9bd06af7f9f1f3a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gaea95ea452d0f17de9bd06af7f9f1f3a7">strpos</a> (sourceString, searchString, [offset]?)</td></tr>
    71. 

  71. <tr class="separator:gaea95ea452d0f17de9bd06af7f9f1f3a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    72. 

  72. <tr class="memitem:ga29ce3d394e74b71a57109211835ab0c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga29ce3d394e74b71a57109211835ab0c3">strrchr</a> (sourceString, char)</td></tr>
    73. 

  73. <tr class="separator:ga29ce3d394e74b71a57109211835ab0c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:ga4e1268b2e16a57b6967d5246b5e8dbb0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga4e1268b2e16a57b6967d5246b5e8dbb0">strreplace</a> (sourceString, from, to)</td></tr>
    75. 

  75. <tr class="separator:ga4e1268b2e16a57b6967d5246b5e8dbb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:gae9f5ef43b0385406834f79bdea12aec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> (sourceString, searchString)</td></tr>
    77. 

  77. <tr class="separator:gae9f5ef43b0385406834f79bdea12aec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. <tr class="memitem:ga00d04a14fa694517811ee2df409ebd59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga00d04a14fa694517811ee2df409ebd59">strupr</a> (sourceString)</td></tr>
    79. 

  79. <tr class="separator:ga00d04a14fa694517811ee2df409ebd59"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:ga61510d39195c7eaab61a609b02c91f74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga61510d39195c7eaab61a609b02c91f74">trim</a> (sourceString)</td></tr>
    81. 

  81. <tr class="separator:ga61510d39195c7eaab61a609b02c91f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. </table>
    83. 

  83. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    84. 

  84. <h2 class="groupheader">Function Documentation</h2>
    85. 

  85. <a class="anchor" id="ga484bcb723e4d8bd6f7e6b362ccbdea27"></a>
    86. 

  86. <div class="memitem">
    87. 

  87. <div class="memproto">
    88. 

  88.       <table class="memname">
    89. 

  89.         <tr>
    90. 

  90.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getSubStr </td>
    91. 

  91.           <td>(</td>
    92. 

  92.           <td class="paramtype">sourceString&#160;</td>
    93. 

  93.           <td class="paramname">, </td>
    94. 

  94.         </tr>
    95. 

  95.         <tr>
    96. 

  96.           <td class="paramkey"></td>
    97. 

  97.           <td></td>
    98. 

  98.           <td class="paramtype">start&#160;</td>
    99. 

  99.           <td class="paramname">, </td>
    100. 

  100.         </tr>
    101. 

  101.         <tr>
    102. 

  102.           <td class="paramkey"></td>
    103. 

  103.           <td></td>
    104. 

  104.           <td class="paramtype">count&#160;</td>
    105. 

  105.           <td class="paramname">&#160;</td>
    106. 

  106.         </tr>
    107. 

  107.         <tr>
    108. 

  108.           <td></td>
    109. 

  109.           <td>)</td>
    110. 

  110.           <td></td><td></td>
    111. 

  111.         </tr>
    112. 

  112.       </table>
    113. 

  113. </div><div class="memdoc">
    114. 

  114. <p>Use the getSubStr function to get a sub-string of sourceString, starting at character index start and ending at character index start + count, or the end-of-string, which ever comes first. If start + count is greater than the length of sourceString, the extraction will return a string shorter than count. </p><dl class="params"><dt>Parameters</dt><dd>
    115. 

  115.   <table class="params">
    116. 

  116.     <tr><td class="paramname">sourceString</td><td>The string from which to extract a sub-string. </td></tr>
    117. 

  117.     <tr><td class="paramname">start</td><td>The character index at which the extraction starts. </td></tr>
    118. 

  118.     <tr><td class="paramname">count</td><td>The length of the sub-string to extract. </td></tr>
    119. 

  119.   </table>
    120. 

  120.   </dd>
    121. 

  121. </dl>
    122. 

  122. <dl class="section return"><dt>Returns</dt><dd>Returns a string made up of the character at start in sourceString and ending at the end of the original sourceString, or start + count, whichever comes first. </dd></dl>
    123. 

  123. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga44cf5b8b8bea66e935d51769da41d268">strchr</a> </dd></dl>
    124. 

  124. 

  125. </div>
    126. 

  126. </div>
    127. 

  127. <a class="anchor" id="ga398dd476c27e2270efec203fcead4f74"></a>
    128. 

  128. <div class="memitem">
    129. 

  129. <div class="memproto">
    130. 

  130.       <table class="memname">
    131. 

  131.         <tr>
    132. 

  132.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> ltrim </td>
    133. 

  133.           <td>(</td>
    134. 

  134.           <td class="paramtype">sourceString&#160;</td>
    135. 

  135.           <td class="paramname"></td><td>)</td>
    136. 

  136.           <td></td>
    137. 

  137.         </tr>
    138. 

  138.       </table>
    139. 

  139. </div><div class="memdoc">
    140. 

  140. <p>Use the ltrim function to strip the leading white space from sourceString. White space is any character in this set: spaces, TABs, and NULL strings. </p><dl class="params"><dt>Parameters</dt><dd>
    141. 

  141.   <table class="params">
    142. 

  142.     <tr><td class="paramname">sourceString</td><td>The string to be trimmed. </td></tr>
    143. 

  143.   </table>
    144. 

  144.   </dd>
    145. 

  145. </dl>
    146. 

  146. <dl class="section return"><dt>Returns</dt><dd>Returns sourceString with all the leading white spaces removed. </dd></dl>
    147. 

  147. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga6732ae030c5401ac4df1568df612e6a0">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#ga39d5c31d3f04fdd1687d2fcda5754136">rtrim</a>, <a class="el" href="group__StringFunctions.html#ga61510d39195c7eaab61a609b02c91f74">trim</a> </dd></dl>
    148. 

  148. 

  149. </div>
    150. 

  150. </div>
    151. 

  151. <a class="anchor" id="ga39d5c31d3f04fdd1687d2fcda5754136"></a>
    152. 

  152. <div class="memitem">
    153. 

  153. <div class="memproto">
    154. 

  154.       <table class="memname">
    155. 

  155.         <tr>
    156. 

  156.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> rtrim </td>
    157. 

  157.           <td>(</td>
    158. 

  158.           <td class="paramtype">sourceString&#160;</td>
    159. 

  159.           <td class="paramname"></td><td>)</td>
    160. 

  160.           <td></td>
    161. 

  161.         </tr>
    162. 

  162.       </table>
    163. 

  163. </div><div class="memdoc">
    164. 

  164. <p>Use the rtrim function to strip the trailing white space from sourceString. White space is any character in this set: spaces, TABs, and NULL strings. </p><dl class="params"><dt>Parameters</dt><dd>
    165. 

  165.   <table class="params">
    166. 

  166.     <tr><td class="paramname">sourceString</td><td>The string to be trimmed. </td></tr>
    167. 

  167.   </table>
    168. 

  168.   </dd>
    169. 

  169. </dl>
    170. 

  170. <dl class="section return"><dt>Returns</dt><dd>Returns sourceString with all the trailing white spaces removed. </dd></dl>
    171. 

  171. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga6732ae030c5401ac4df1568df612e6a0">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#ga398dd476c27e2270efec203fcead4f74">ltrim</a>, <a class="el" href="group__StringFunctions.html#ga61510d39195c7eaab61a609b02c91f74">trim</a> </dd></dl>
    172. 

  172. 

  173. </div>
    174. 

  174. </div>
    175. 

  175. <a class="anchor" id="ga44cf5b8b8bea66e935d51769da41d268"></a>
    176. 

  176. <div class="memitem">
    177. 

  177. <div class="memproto">
    178. 

  178.       <table class="memname">
    179. 

  179.         <tr>
    180. 

  180.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strchr </td>
    181. 

  181.           <td>(</td>
    182. 

  182.           <td class="paramtype">sourceString&#160;</td>
    183. 

  183.           <td class="paramname">, </td>
    184. 

  184.         </tr>
    185. 

  185.         <tr>
    186. 

  186.           <td class="paramkey"></td>
    187. 

  187.           <td></td>
    188. 

  188.           <td class="paramtype">char&#160;</td>
    189. 

  189.           <td class="paramname">&#160;</td>
    190. 

  190.         </tr>
    191. 

  191.         <tr>
    192. 

  192.           <td></td>
    193. 

  193.           <td>)</td>
    194. 

  194.           <td></td><td></td>
    195. 

  195.         </tr>
    196. 

  196.       </table>
    197. 

  197. </div><div class="memdoc">
    198. 

  198. <p>Use the strchr function to extract a sub-string of sourceString, where the sub-string is equal to the first occurence of char in sourceString followed by the remainder of sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
    199. 

  199.   <table class="params">
    200. 

  200.     <tr><td class="paramname">sourceString</td><td>The string from which to extract a sub-string. </td></tr>
    201. 

  201.     <tr><td class="paramname">char</td><td>The character to search for in sourceString. </td></tr>
    202. 

  202.   </table>
    203. 

  203.   </dd>
    204. 

  204. </dl>
    205. 

  205. <dl class="section return"><dt>Returns</dt><dd>Returns a string composed of first instance of char in sourceString, and all of the characters after it. If char is not found, a NULL string is returned. </dd></dl>
    206. 

  206. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga484bcb723e4d8bd6f7e6b362ccbdea27">getSubStr</a> </dd></dl>
    207. 

  207. 

  208. </div>
    209. 

  209. </div>
    210. 

  210. <a class="anchor" id="gadd80e9144f64c2e3219a74be1198b4d2"></a>
    211. 

  211. <div class="memitem">
    212. 

  212. <div class="memproto">
    213. 

  213.       <table class="memname">
    214. 

  214.         <tr>
    215. 

  215.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> strcmp </td>
    216. 

  216.           <td>(</td>
    217. 

  217.           <td class="paramtype">string1&#160;</td>
    218. 

  218.           <td class="paramname">, </td>
    219. 

  219.         </tr>
    220. 

  220.         <tr>
    221. 

  221.           <td class="paramkey"></td>
    222. 

  222.           <td></td>
    223. 

  223.           <td class="paramtype">string2&#160;</td>
    224. 

  224.           <td class="paramname">&#160;</td>
    225. 

  225.         </tr>
    226. 

  226.         <tr>
    227. 

  227.           <td></td>
    228. 

  228.           <td>)</td>
    229. 

  229.           <td></td><td></td>
    230. 

  230.         </tr>
    231. 

  231.       </table>
    232. 

  232. </div><div class="memdoc">
    233. 

  233. <p>Use the strcmp function to do a lexicographic case sensitive string comparison between string1 and string2. </p><dl class="params"><dt>Parameters</dt><dd>
    234. 

  234.   <table class="params">
    235. 

  235.     <tr><td class="paramname">string1</td><td>String to be compared to string2. </td></tr>
    236. 

  236.     <tr><td class="paramname">string2</td><td>String to be compared to string1. </td></tr>
    237. 

  237.   </table>
    238. 

  238.   </dd>
    239. 

  239. </dl>
    240. 

  240. <dl class="section return"><dt>Returns</dt><dd>Returns a numeric value: &lt;-1 (string1 is less than string2, including case), 0 (string1 is equal to string2, including case), 1 (string1 is greater than string2, including case)&gt;. </dd></dl>
    241. 

  241. <dl class="section see"><dt>See also</dt><dd>see <a class="el" href="group__StringFunctions.html#gae26368e0921a917a0644f6f4c38ceeb7">stricmp</a>, <a class="el" href="group__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> </dd></dl>
    242. 

  242. 

  243. </div>
    244. 

  244. </div>
    245. 

  245. <a class="anchor" id="gae26368e0921a917a0644f6f4c38ceeb7"></a>
    246. 

  246. <div class="memitem">
    247. 

  247. <div class="memproto">
    248. 

  248.       <table class="memname">
    249. 

  249.         <tr>
    250. 

  250.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> stricmp </td>
    251. 

  251.           <td>(</td>
    252. 

  252.           <td class="paramtype">string1&#160;</td>
    253. 

  253.           <td class="paramname">, </td>
    254. 

  254.         </tr>
    255. 

  255.         <tr>
    256. 

  256.           <td class="paramkey"></td>
    257. 

  257.           <td></td>
    258. 

  258.           <td class="paramtype">string2&#160;</td>
    259. 

  259.           <td class="paramname">&#160;</td>
    260. 

  260.         </tr>
    261. 

  261.         <tr>
    262. 

  262.           <td></td>
    263. 

  263.           <td>)</td>
    264. 

  264.           <td></td><td></td>
    265. 

  265.         </tr>
    266. 

  266.       </table>
    267. 

  267. </div><div class="memdoc">
    268. 

  268. <p>Use the stricmp function to do a lexicographic case in-sensitive string comparison between string1 and string2. </p><dl class="params"><dt>Parameters</dt><dd>
    269. 

  269.   <table class="params">
    270. 

  270.     <tr><td class="paramname">string1</td><td>String to be compared to string2. </td></tr>
    271. 

  271.     <tr><td class="paramname">string2</td><td>String to be compared to string1. </td></tr>
    272. 

  272.   </table>
    273. 

  273.   </dd>
    274. 

  274. </dl>
    275. 

  275. <dl class="section return"><dt>Returns</dt><dd>Returns a numeric value: &lt;-1 (string1 is less than string2, ignoring case), 0 (string1 is equal to string2, ignoring case), 1 (string1 is greater than string2, ignoring case)&gt;. </dd></dl>
    276. 

  276. <dl class="section see"><dt>See also</dt><dd>see <a class="el" href="group__StringFunctions.html#gadd80e9144f64c2e3219a74be1198b4d2">strcmp</a>, <a class="el" href="group__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> </dd></dl>
    277. 

  277. 

  278. </div>
    279. 

  279. </div>
    280. 

  280. <a class="anchor" id="ga6732ae030c5401ac4df1568df612e6a0"></a>
    281. 

  281. <div class="memitem">
    282. 

  282. <div class="memproto">
    283. 

  283.       <table class="memname">
    284. 

  284.         <tr>
    285. 

  285.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> stripChars </td>
    286. 

  286.           <td>(</td>
    287. 

  287.           <td class="paramtype">sourceString&#160;</td>
    288. 

  288.           <td class="paramname">, </td>
    289. 

  289.         </tr>
    290. 

  290.         <tr>
    291. 

  291.           <td class="paramkey"></td>
    292. 

  292.           <td></td>
    293. 

  293.           <td class="paramtype">chars&#160;</td>
    294. 

  294.           <td class="paramname">&#160;</td>
    295. 

  295.         </tr>
    296. 

  296.         <tr>
    297. 

  297.           <td></td>
    298. 

  298.           <td>)</td>
    299. 

  299.           <td></td><td></td>
    300. 

  300.         </tr>
    301. 

  301.       </table>
    302. 

  302. </div><div class="memdoc">
    303. 

  303. <p>Use the stripChars function to remove chars from sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
    304. 

  304.   <table class="params">
    305. 

  305.     <tr><td class="paramname">sourceString</td><td>The string to be modified. </td></tr>
    306. 

  306.     <tr><td class="paramname">chars</td><td>The character or characters to search for and remove. </td></tr>
    307. 

  307.   </table>
    308. 

  308.   </dd>
    309. 

  309. </dl>
    310. 

  310. <dl class="section return"><dt>Returns</dt><dd>Returns a copy of sourceString, from which all instances of chars have been removed. This may be the original sourceString, if chars was not found. </dd></dl>
    311. 

  311. <dl class="section see"><dt>See also</dt><dd>stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a> </dd></dl>
    312. 

  312. 

  313. </div>
    314. 

  314. </div>
    315. 

  315. <a class="anchor" id="ga8146a7417e5547eb8218351806454ed3"></a>
    316. 

  316. <div class="memitem">
    317. 

  317. <div class="memproto">
    318. 

  318.       <table class="memname">
    319. 

  319.         <tr>
    320. 

  320.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> stripColorCodes </td>
    321. 

  321.           <td>(</td>
    322. 

  322.           <td class="paramtype">stringtoStrip&#160;</td>
    323. 

  323.           <td class="paramname"></td><td>)</td>
    324. 

  324.           <td></td>
    325. 

  325.         </tr>
    326. 

  326.       </table>
    327. 

  327. </div><div class="memdoc">
    328. 

  328. <p>remove TorqueML color codes from the string. </p><dl class="params"><dt>Parameters</dt><dd>
    329. 

  329.   <table class="params">
    330. 

  330.     <tr><td class="paramname">stringtoString</td><td>The string from which to remove TorqueML color codes </td></tr>
    331. 

  331.   </table>
    332. 

  332.   </dd>
    333. 

  333. </dl>
    334. 

  334. <dl class="section return"><dt>Returns</dt><dd>A string consisting of the original string minus color codes </dd></dl>
    335. 

  335. 

  336. </div>
    337. 

  337. </div>
    338. 

  338. <a class="anchor" id="gaa0f0826c103e5d3da9790db75545ce11"></a>
    339. 

  339. <div class="memitem">
    340. 

  340. <div class="memproto">
    341. 

  341.       <table class="memname">
    342. 

  342.         <tr>
    343. 

  343.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> stripTrailingSpaces </td>
    344. 

  344.           <td>(</td>
    345. 

  345.           <td class="paramtype">string&#160;</td>
    346. 

  346.           <td class="paramname"></td><td>)</td>
    347. 

  347.           <td></td>
    348. 

  348.         </tr>
    349. 

  349.       </table>
    350. 

  350. </div><div class="memdoc">
    351. 

  351. <p>Removes all spaces after the final </p><dl class="params"><dt>Parameters</dt><dd>
    352. 

  352.   <table class="params">
    353. 

  353.     <tr><td class="paramname">string</td><td>from which to remove trailing spaces </td></tr>
    354. 

  354.   </table>
    355. 

  355.   </dd>
    356. 

  356. </dl>
    357. 

  357. <dl class="section return"><dt>Returns</dt><dd>the source string minus trailing spaces </dd></dl>
    358. 

  358. 

  359. </div>
    360. 

  360. </div>
    361. 

  361. <a class="anchor" id="gadebd1409d216aaa04765a5c45f4d433d"></a>
    362. 

  362. <div class="memitem">
    363. 

  363. <div class="memproto">
    364. 

  364.       <table class="memname">
    365. 

  365.         <tr>
    366. 

  366.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> strlen </td>
    367. 

  367.           <td>(</td>
    368. 

  368.           <td class="paramtype">string&#160;</td>
    369. 

  369.           <td class="paramname"></td><td>)</td>
    370. 

  370.           <td></td>
    371. 

  371.         </tr>
    372. 

  372.       </table>
    373. 

  373. </div><div class="memdoc">
    374. 

  374. <p>Use the strlen function to determine how many characters there are in string. </p><dl class="params"><dt>Parameters</dt><dd>
    375. 

  375.   <table class="params">
    376. 

  376.     <tr><td class="paramname">string</td><td>The string to count characters for. </td></tr>
    377. 

  377.   </table>
    378. 

  378.   </dd>
    379. 

  379. </dl>
    380. 

  380. <dl class="section return"><dt>Returns</dt><dd>Returns the number of characters in string, or 0 if string is invalid or a NULL string </dd></dl>
    381. 

  381. 

  382. </div>
    383. 

  383. </div>
    384. 

  384. <a class="anchor" id="ga4ca39bba5a20c2b54cbf832c86825b9f"></a>
    385. 

  385. <div class="memitem">
    386. 

  386. <div class="memproto">
    387. 

  387.       <table class="memname">
    388. 

  388.         <tr>
    389. 

  389.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strlwr </td>
    390. 

  390.           <td>(</td>
    391. 

  391.           <td class="paramtype">sourceString&#160;</td>
    392. 

  392.           <td class="paramname"></td><td>)</td>
    393. 

  393.           <td></td>
    394. 

  394.         </tr>
    395. 

  395.       </table>
    396. 

  396. </div><div class="memdoc">
    397. 

  397. <p>Use the strlwr function to convert all alpha characters in sourceString to lower-case equivalents. </p><dl class="params"><dt>Parameters</dt><dd>
    398. 

  398.   <table class="params">
    399. 

  399.     <tr><td class="paramname">sourceString</td><td>The string to be modified. </td></tr>
    400. 

  400.   </table>
    401. 

  401.   </dd>
    402. 

  402. </dl>
    403. 

  403. <dl class="section return"><dt>Returns</dt><dd>Returns a copy of sourceString in which all upper-case characters have been converted to lower-case letters. </dd></dl>
    404. 

  404. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga00d04a14fa694517811ee2df409ebd59">strupr</a> </dd></dl>
    405. 

  405. 

  406. </div>
    407. 

  407. </div>
    408. 

  408. <a class="anchor" id="gaea95ea452d0f17de9bd06af7f9f1f3a7"></a>
    409. 

  409. <div class="memitem">
    410. 

  410. <div class="memproto">
    411. 

  411.       <table class="memname">
    412. 

  412.         <tr>
    413. 

  413.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> strpos </td>
    414. 

  414.           <td>(</td>
    415. 

  415.           <td class="paramtype">sourceString&#160;</td>
    416. 

  416.           <td class="paramname">, </td>
    417. 

  417.         </tr>
    418. 

  418.         <tr>
    419. 

  419.           <td class="paramkey"></td>
    420. 

  420.           <td></td>
    421. 

  421.           <td class="paramtype">searchString&#160;</td>
    422. 

  422.           <td class="paramname">, </td>
    423. 

  423.         </tr>
    424. 

  424.         <tr>
    425. 

  425.           <td class="paramkey"></td>
    426. 

  426.           <td></td>
    427. 

  427.           <td class="paramtype">[offset] ?&#160;</td>
    428. 

  428.           <td class="paramname">&#160;</td>
    429. 

  429.         </tr>
    430. 

  430.         <tr>
    431. 

  431.           <td></td>
    432. 

  432.           <td>)</td>
    433. 

  433.           <td></td><td></td>
    434. 

  434.         </tr>
    435. 

  435.       </table>
    436. 

  436. </div><div class="memdoc">
    437. 

  437. <p>Use the strPos function to locate the first instance of searchString in sourceString, starting at character 0, or at an optional offset. </p><dl class="params"><dt>Parameters</dt><dd>
    438. 

  438.   <table class="params">
    439. 

  439.     <tr><td class="paramname">sourceString</td><td>The string in which to search for searchString. </td></tr>
    440. 

  440.     <tr><td class="paramname">searchString</td><td>The string for which to search for in sourceString. </td></tr>
    441. 

  441.     <tr><td class="paramname">offset</td><td>An optional non-negative integer value representing the character offset within sourceString at which to begin the search. </td></tr>
    442. 

  442.   </table>
    443. 

  443.   </dd>
    444. 

  444. </dl>
    445. 

  445. <dl class="section return"><dt>Returns</dt><dd>Returns a numeric character index representing the postion in sourceString at which searchString was found, or -1 to indicate that no instance of searchString was found. </dd></dl>
    446. 

  446. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> </dd></dl>
    447. 

  447. 

  448. </div>
    449. 

  449. </div>
    450. 

  450. <a class="anchor" id="ga29ce3d394e74b71a57109211835ab0c3"></a>
    451. 

  451. <div class="memitem">
    452. 

  452. <div class="memproto">
    453. 

  453.       <table class="memname">
    454. 

  454.         <tr>
    455. 

  455.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strrchr </td>
    456. 

  456.           <td>(</td>
    457. 

  457.           <td class="paramtype">sourceString&#160;</td>
    458. 

  458.           <td class="paramname">, </td>
    459. 

  459.         </tr>
    460. 

  460.         <tr>
    461. 

  461.           <td class="paramkey"></td>
    462. 

  462.           <td></td>
    463. 

  463.           <td class="paramtype">char&#160;</td>
    464. 

  464.           <td class="paramname">&#160;</td>
    465. 

  465.         </tr>
    466. 

  466.         <tr>
    467. 

  467.           <td></td>
    468. 

  468.           <td>)</td>
    469. 

  469.           <td></td><td></td>
    470. 

  470.         </tr>
    471. 

  471.       </table>
    472. 

  472. </div><div class="memdoc">
    473. 

  473. <p>strrchr searches the sourceString for the last occurance of the giuven char </p><dl class="params"><dt>Parameters</dt><dd>
    474. 

  474.   <table class="params">
    475. 

  475.     <tr><td class="paramname">sourceString</td><td>The string to search </td></tr>
    476. 

  476.   </table>
    477. 

  477.   </dd>
    478. 

  478. </dl>
    479. 

  479. <dl class="section return"><dt>Returns</dt><dd>Either a string consisting of the given string from the last occurance of the given char on or an empty string if not found </dd></dl>
    480. 

  480. 

  481. </div>
    482. 

  482. </div>
    483. 

  483. <a class="anchor" id="ga4e1268b2e16a57b6967d5246b5e8dbb0"></a>
    484. 

  484. <div class="memitem">
    485. 

  485. <div class="memproto">
    486. 

  486.       <table class="memname">
    487. 

  487.         <tr>
    488. 

  488.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strreplace </td>
    489. 

  489.           <td>(</td>
    490. 

  490.           <td class="paramtype">sourceString&#160;</td>
    491. 

  491.           <td class="paramname">, </td>
    492. 

  492.         </tr>
    493. 

  493.         <tr>
    494. 

  494.           <td class="paramkey"></td>
    495. 

  495.           <td></td>
    496. 

  496.           <td class="paramtype">from&#160;</td>
    497. 

  497.           <td class="paramname">, </td>
    498. 

  498.         </tr>
    499. 

  499.         <tr>
    500. 

  500.           <td class="paramkey"></td>
    501. 

  501.           <td></td>
    502. 

  502.           <td class="paramtype">to&#160;</td>
    503. 

  503.           <td class="paramname">&#160;</td>
    504. 

  504.         </tr>
    505. 

  505.         <tr>
    506. 

  506.           <td></td>
    507. 

  507.           <td>)</td>
    508. 

  508.           <td></td><td></td>
    509. 

  509.         </tr>
    510. 

  510.       </table>
    511. 

  511. </div><div class="memdoc">
    512. 

  512. <p>Use the strreplace function to replace every instance of from in sourceString with to. This function is case-sensitive and only does exact matching </p><dl class="params"><dt>Parameters</dt><dd>
    513. 

  513.   <table class="params">
    514. 

  514.     <tr><td class="paramname">sourceString</td><td>The string to do replacement operations on. </td></tr>
    515. 

  515.     <tr><td class="paramname">from</td><td>The old value to be replaced. </td></tr>
    516. 

  516.     <tr><td class="paramname">to</td><td>The new value to replace old values with. </td></tr>
    517. 

  517.   </table>
    518. 

  518.   </dd>
    519. 

  519. </dl>
    520. 

  520. <dl class="section return"><dt>Returns</dt><dd>Returns a new version of sourceString in which every instance of the value in from was replaced with the value in to. </dd></dl>
    521. 

  521. 

  522. </div>
    523. 

  523. </div>
    524. 

  524. <a class="anchor" id="gae9f5ef43b0385406834f79bdea12aec6"></a>
    525. 

  525. <div class="memitem">
    526. 

  526. <div class="memproto">
    527. 

  527.       <table class="memname">
    528. 

  528.         <tr>
    529. 

  529.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> strstr </td>
    530. 

  530.           <td>(</td>
    531. 

  531.           <td class="paramtype">sourceString&#160;</td>
    532. 

  532.           <td class="paramname">, </td>
    533. 

  533.         </tr>
    534. 

  534.         <tr>
    535. 

  535.           <td class="paramkey"></td>
    536. 

  536.           <td></td>
    537. 

  537.           <td class="paramtype">searchString&#160;</td>
    538. 

  538.           <td class="paramname">&#160;</td>
    539. 

  539.         </tr>
    540. 

  540.         <tr>
    541. 

  541.           <td></td>
    542. 

  542.           <td>)</td>
    543. 

  543.           <td></td><td></td>
    544. 

  544.         </tr>
    545. 

  545.       </table>
    546. 

  546. </div><div class="memdoc">
    547. 

  547. <p>Use the strstr function to locate the first instance of searchString in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
    548. 

  548.   <table class="params">
    549. 

  549.     <tr><td class="paramname">sourceString</td><td>The string in which to search for searchString. </td></tr>
    550. 

  550.     <tr><td class="paramname">searchString</td><td>The string for which to search for in sourceString. </td></tr>
    551. 

  551.   </table>
    552. 

  552.   </dd>
    553. 

  553. </dl>
    554. 

  554. <dl class="section return"><dt>Returns</dt><dd>Returns a numeric character index representing the position in sourceString at which searchString was found, or -1 to indicate that no instance of searchString was found. </dd></dl>
    555. 

  555. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#gaea95ea452d0f17de9bd06af7f9f1f3a7">strpos</a> </dd></dl>
    556. 

  556. 

  557. </div>
    558. 

  558. </div>
    559. 

  559. <a class="anchor" id="ga00d04a14fa694517811ee2df409ebd59"></a>
    560. 

  560. <div class="memitem">
    561. 

  561. <div class="memproto">
    562. 

  562.       <table class="memname">
    563. 

  563.         <tr>
    564. 

  564.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strupr </td>
    565. 

  565.           <td>(</td>
    566. 

  566.           <td class="paramtype">sourceString&#160;</td>
    567. 

  567.           <td class="paramname"></td><td>)</td>
    568. 

  568.           <td></td>
    569. 

  569.         </tr>
    570. 

  570.       </table>
    571. 

  571. </div><div class="memdoc">
    572. 

  572. <p>Use the strupr function to convert all alpha characters in sourceString to upper-case equivalents. </p><dl class="params"><dt>Parameters</dt><dd>
    573. 

  573.   <table class="params">
    574. 

  574.     <tr><td class="paramname">sourceString</td><td>The string to be modified. </td></tr>
    575. 

  575.   </table>
    576. 

  576.   </dd>
    577. 

  577. </dl>
    578. 

  578. <dl class="section return"><dt>Returns</dt><dd>Returns a copy of sourceString in which all lower-case characters have been converted to upper-case letters. </dd></dl>
    579. 

  579. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga4ca39bba5a20c2b54cbf832c86825b9f">strlwr</a> </dd></dl>
    580. 

  580. 

  581. </div>
    582. 

  582. </div>
    583. 

  583. <a class="anchor" id="ga61510d39195c7eaab61a609b02c91f74"></a>
    584. 

  584. <div class="memitem">
    585. 

  585. <div class="memproto">
    586. 

  586.       <table class="memname">
    587. 

  587.         <tr>
    588. 

  588.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> trim </td>
    589. 

  589.           <td>(</td>
    590. 

  590.           <td class="paramtype">sourceString&#160;</td>
    591. 

  591.           <td class="paramname"></td><td>)</td>
    592. 

  592.           <td></td>
    593. 

  593.         </tr>
    594. 

  594.       </table>
    595. 

  595. </div><div class="memdoc">
    596. 

  596. <p>Use the trim function to strip the leading and trailing white space from sourceString. White space is any character in this set: spaces, TABs, and NULL strings. </p><dl class="params"><dt>Parameters</dt><dd>
    597. 

  597.   <table class="params">
    598. 

  598.     <tr><td class="paramname">sourceString</td><td>The string to be trimmed. </td></tr>
    599. 

  599.   </table>
    600. 

  600.   </dd>
    601. 

  601. </dl>
    602. 

  602. <dl class="section return"><dt>Returns</dt><dd>Returns sourceString with all the leading and trailing white spaces removed. </dd></dl>
    603. 

  603. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga6732ae030c5401ac4df1568df612e6a0">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#ga398dd476c27e2270efec203fcead4f74">ltrim</a>, <a class="el" href="group__StringFunctions.html#ga39d5c31d3f04fdd1687d2fcda5754136">rtrim</a> </dd></dl>
    604. 

  604. 

  605. </div>
    606. 

  606. </div>
    607. 

  607. </div><!-- contents -->
    608. 

  608. <!-- start footer part -->
    609. 

  609. <hr class="footer"/><address class="footer"><small>
    610. 

  610. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    611. 

  611. <img class="footer" src="doxygen.png" alt="doxygen"/>
    612. 

  612. </a> 1.8.10
    613. 

  613. </small></address>
    614. 

  614. </body>
    615. 

  615. </html>
    616.