Inicio Explorar Ayuda
Iniciar sesión
TorqueEngine
/
Torque2D
espejo de https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Archivos Incidencias 0 Wiki
Árbol: 9aa0867d16
Ramas Etiquetas
Torque2D
/
TorqueScriptDocs
/
html
/
group__StringFunctions.html

group__StringFunctions.html 34 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633 
  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.3.1"/>
    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 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.3.1 -->
    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="pages.html"><span>Related&#160;Pages</span></a></li>
    34. 

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

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

  36.     </ul>
    37. 

  37.   </div>
    38. 

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

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

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

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

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

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

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

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

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

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

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

  49. <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>
    50. 

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

  51. <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>
    52. 

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

  53. <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>
    54. 

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

  55. <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>
    56. 

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

  57. <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>
    58. 

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

  59. <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>
    60. 

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

  61. <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>
    62. 

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

  63. <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>
    64. 

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

  65. <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>
    66. 

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

  67. <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>
    68. 

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

  69. <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>
    70. 

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

  71. <tr class="memitem:ga2fdd893119d727067a003bef32e57bdd"><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#ga2fdd893119d727067a003bef32e57bdd">strpos</a> (sourceString, searchString,[offset]?)</td></tr>
    72. 

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

  73. <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>
    74. 

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

  75. <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>
    76. 

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

  77. <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>
    78. 

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

  79. <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>
    80. 

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

  81. <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>
    82. 

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

  83. </table>
    84. 

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

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

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

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

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

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

  90.         <tr>
    91. 

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

  92.           <td>(</td>
    93. 

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

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

  95.         </tr>
    96. 

  96.         <tr>
    97. 

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

  98.           <td></td>
    99. 

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

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

  101.         </tr>
    102. 

  102.         <tr>
    103. 

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

  104.           <td></td>
    105. 

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

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

  107.         </tr>
    108. 

  108.         <tr>
    109. 

  109.           <td></td>
    110. 

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

  111.           <td></td><td></td>
    112. 

  112.         </tr>
    113. 

  113.       </table>
    114. 

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

  115. <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>
    116. 

  116. <dl class="params"><dt>Parameters</dt><dd>
    117. 

  117.   <table class="params">
    118. 

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

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

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

  121.   </table>
    122. 

  122.   </dd>
    123. 

  123. </dl>
    124. 

  124. <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>
    125. 

  125. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga44cf5b8b8bea66e935d51769da41d268">strchr</a> </dd></dl>
    126. 

  126. 

  127. </div>
    128. 

  128. </div>
    129. 

  129. <a class="anchor" id="ga398dd476c27e2270efec203fcead4f74"></a>
    130. 

  130. <div class="memitem">
    131. 

  131. <div class="memproto">
    132. 

  132.       <table class="memname">
    133. 

  133.         <tr>
    134. 

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

  135.           <td>(</td>
    136. 

  136.           <td class="paramtype">sourceString&#160;</td>
    137. 

  137.           <td class="paramname"></td><td>)</td>
    138. 

  138.           <td></td>
    139. 

  139.         </tr>
    140. 

  140.       </table>
    141. 

  141. </div><div class="memdoc">
    142. 

  142. <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>
    143. 

  143. <dl class="params"><dt>Parameters</dt><dd>
    144. 

  144.   <table class="params">
    145. 

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

  146.   </table>
    147. 

  147.   </dd>
    148. 

  148. </dl>
    149. 

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

  150. <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>
    151. 

  151. 

  152. </div>
    153. 

  153. </div>
    154. 

  154. <a class="anchor" id="ga39d5c31d3f04fdd1687d2fcda5754136"></a>
    155. 

  155. <div class="memitem">
    156. 

  156. <div class="memproto">
    157. 

  157.       <table class="memname">
    158. 

  158.         <tr>
    159. 

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

  160.           <td>(</td>
    161. 

  161.           <td class="paramtype">sourceString&#160;</td>
    162. 

  162.           <td class="paramname"></td><td>)</td>
    163. 

  163.           <td></td>
    164. 

  164.         </tr>
    165. 

  165.       </table>
    166. 

  166. </div><div class="memdoc">
    167. 

  167. <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>
    168. 

  168. <dl class="params"><dt>Parameters</dt><dd>
    169. 

  169.   <table class="params">
    170. 

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

  171.   </table>
    172. 

  172.   </dd>
    173. 

  173. </dl>
    174. 

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

  175. <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>
    176. 

  176. 

  177. </div>
    178. 

  178. </div>
    179. 

  179. <a class="anchor" id="ga44cf5b8b8bea66e935d51769da41d268"></a>
    180. 

  180. <div class="memitem">
    181. 

  181. <div class="memproto">
    182. 

  182.       <table class="memname">
    183. 

  183.         <tr>
    184. 

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

  185.           <td>(</td>
    186. 

  186.           <td class="paramtype">sourceString&#160;</td>
    187. 

  187.           <td class="paramname">, </td>
    188. 

  188.         </tr>
    189. 

  189.         <tr>
    190. 

  190.           <td class="paramkey"></td>
    191. 

  191.           <td></td>
    192. 

  192.           <td class="paramtype">char&#160;</td>
    193. 

  193.           <td class="paramname">&#160;</td>
    194. 

  194.         </tr>
    195. 

  195.         <tr>
    196. 

  196.           <td></td>
    197. 

  197.           <td>)</td>
    198. 

  198.           <td></td><td></td>
    199. 

  199.         </tr>
    200. 

  200.       </table>
    201. 

  201. </div><div class="memdoc">
    202. 

  202. <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>
    203. 

  203. <dl class="params"><dt>Parameters</dt><dd>
    204. 

  204.   <table class="params">
    205. 

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

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

  207.   </table>
    208. 

  208.   </dd>
    209. 

  209. </dl>
    210. 

  210. <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>
    211. 

  211. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga484bcb723e4d8bd6f7e6b362ccbdea27">getSubStr</a> </dd></dl>
    212. 

  212. 

  213. </div>
    214. 

  214. </div>
    215. 

  215. <a class="anchor" id="gadd80e9144f64c2e3219a74be1198b4d2"></a>
    216. 

  216. <div class="memitem">
    217. 

  217. <div class="memproto">
    218. 

  218.       <table class="memname">
    219. 

  219.         <tr>
    220. 

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

  221.           <td>(</td>
    222. 

  222.           <td class="paramtype">string1&#160;</td>
    223. 

  223.           <td class="paramname">, </td>
    224. 

  224.         </tr>
    225. 

  225.         <tr>
    226. 

  226.           <td class="paramkey"></td>
    227. 

  227.           <td></td>
    228. 

  228.           <td class="paramtype">string2&#160;</td>
    229. 

  229.           <td class="paramname">&#160;</td>
    230. 

  230.         </tr>
    231. 

  231.         <tr>
    232. 

  232.           <td></td>
    233. 

  233.           <td>)</td>
    234. 

  234.           <td></td><td></td>
    235. 

  235.         </tr>
    236. 

  236.       </table>
    237. 

  237. </div><div class="memdoc">
    238. 

  238. <p>Use the strcmp function to do a lexicographic case sensitive string comparison between string1 and string2. </p>
    239. 

  239. <dl class="params"><dt>Parameters</dt><dd>
    240. 

  240.   <table class="params">
    241. 

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

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

  243.   </table>
    244. 

  244.   </dd>
    245. 

  245. </dl>
    246. 

  246. <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>
    247. 

  247. <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>
    248. 

  248. 

  249. </div>
    250. 

  250. </div>
    251. 

  251. <a class="anchor" id="gae26368e0921a917a0644f6f4c38ceeb7"></a>
    252. 

  252. <div class="memitem">
    253. 

  253. <div class="memproto">
    254. 

  254.       <table class="memname">
    255. 

  255.         <tr>
    256. 

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

  257.           <td>(</td>
    258. 

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

  259.           <td class="paramname">, </td>
    260. 

  260.         </tr>
    261. 

  261.         <tr>
    262. 

  262.           <td class="paramkey"></td>
    263. 

  263.           <td></td>
    264. 

  264.           <td class="paramtype">string2&#160;</td>
    265. 

  265.           <td class="paramname">&#160;</td>
    266. 

  266.         </tr>
    267. 

  267.         <tr>
    268. 

  268.           <td></td>
    269. 

  269.           <td>)</td>
    270. 

  270.           <td></td><td></td>
    271. 

  271.         </tr>
    272. 

  272.       </table>
    273. 

  273. </div><div class="memdoc">
    274. 

  274. <p>Use the stricmp function to do a lexicographic case in-sensitive string comparison between string1 and string2. </p>
    275. 

  275. <dl class="params"><dt>Parameters</dt><dd>
    276. 

  276.   <table class="params">
    277. 

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

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

  279.   </table>
    280. 

  280.   </dd>
    281. 

  281. </dl>
    282. 

  282. <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>
    283. 

  283. <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>
    284. 

  284. 

  285. </div>
    286. 

  286. </div>
    287. 

  287. <a class="anchor" id="ga6732ae030c5401ac4df1568df612e6a0"></a>
    288. 

  288. <div class="memitem">
    289. 

  289. <div class="memproto">
    290. 

  290.       <table class="memname">
    291. 

  291.         <tr>
    292. 

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

  293.           <td>(</td>
    294. 

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

  295.           <td class="paramname">, </td>
    296. 

  296.         </tr>
    297. 

  297.         <tr>
    298. 

  298.           <td class="paramkey"></td>
    299. 

  299.           <td></td>
    300. 

  300.           <td class="paramtype">chars&#160;</td>
    301. 

  301.           <td class="paramname">&#160;</td>
    302. 

  302.         </tr>
    303. 

  303.         <tr>
    304. 

  304.           <td></td>
    305. 

  305.           <td>)</td>
    306. 

  306.           <td></td><td></td>
    307. 

  307.         </tr>
    308. 

  308.       </table>
    309. 

  309. </div><div class="memdoc">
    310. 

  310. <p>Use the stripChars function to remove chars from sourceString. </p>
    311. 

  311. <dl class="params"><dt>Parameters</dt><dd>
    312. 

  312.   <table class="params">
    313. 

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

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

  315.   </table>
    316. 

  316.   </dd>
    317. 

  317. </dl>
    318. 

  318. <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>
    319. 

  319. <dl class="section see"><dt>See Also</dt><dd>stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a> </dd></dl>
    320. 

  320. 

  321. </div>
    322. 

  322. </div>
    323. 

  323. <a class="anchor" id="ga8146a7417e5547eb8218351806454ed3"></a>
    324. 

  324. <div class="memitem">
    325. 

  325. <div class="memproto">
    326. 

  326.       <table class="memname">
    327. 

  327.         <tr>
    328. 

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

  329.           <td>(</td>
    330. 

  330.           <td class="paramtype">stringtoStrip&#160;</td>
    331. 

  331.           <td class="paramname"></td><td>)</td>
    332. 

  332.           <td></td>
    333. 

  333.         </tr>
    334. 

  334.       </table>
    335. 

  335. </div><div class="memdoc">
    336. 

  336. <p>remove TorqueML color codes from the string. </p>
    337. 

  337. <dl class="params"><dt>Parameters</dt><dd>
    338. 

  338.   <table class="params">
    339. 

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

  340.   </table>
    341. 

  341.   </dd>
    342. 

  342. </dl>
    343. 

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

  344. 

  345. </div>
    346. 

  346. </div>
    347. 

  347. <a class="anchor" id="gaa0f0826c103e5d3da9790db75545ce11"></a>
    348. 

  348. <div class="memitem">
    349. 

  349. <div class="memproto">
    350. 

  350.       <table class="memname">
    351. 

  351.         <tr>
    352. 

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

  353.           <td>(</td>
    354. 

  354.           <td class="paramtype">string&#160;</td>
    355. 

  355.           <td class="paramname"></td><td>)</td>
    356. 

  356.           <td></td>
    357. 

  357.         </tr>
    358. 

  358.       </table>
    359. 

  359. </div><div class="memdoc">
    360. 

  360. <p>Removes all spaces after the final </p>
    361. 

  361. <dl class="params"><dt>Parameters</dt><dd>
    362. 

  362.   <table class="params">
    363. 

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

  364.   </table>
    365. 

  365.   </dd>
    366. 

  366. </dl>
    367. 

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

  368. 

  369. </div>
    370. 

  370. </div>
    371. 

  371. <a class="anchor" id="gadebd1409d216aaa04765a5c45f4d433d"></a>
    372. 

  372. <div class="memitem">
    373. 

  373. <div class="memproto">
    374. 

  374.       <table class="memname">
    375. 

  375.         <tr>
    376. 

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

  377.           <td>(</td>
    378. 

  378.           <td class="paramtype">string&#160;</td>
    379. 

  379.           <td class="paramname"></td><td>)</td>
    380. 

  380.           <td></td>
    381. 

  381.         </tr>
    382. 

  382.       </table>
    383. 

  383. </div><div class="memdoc">
    384. 

  384. <p>Use the strlen function to determine how many characters there are in string. </p>
    385. 

  385. <dl class="params"><dt>Parameters</dt><dd>
    386. 

  386.   <table class="params">
    387. 

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

  388.   </table>
    389. 

  389.   </dd>
    390. 

  390. </dl>
    391. 

  391. <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>
    392. 

  392. 

  393. </div>
    394. 

  394. </div>
    395. 

  395. <a class="anchor" id="ga4ca39bba5a20c2b54cbf832c86825b9f"></a>
    396. 

  396. <div class="memitem">
    397. 

  397. <div class="memproto">
    398. 

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

  399.         <tr>
    400. 

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

  401.           <td>(</td>
    402. 

  402.           <td class="paramtype">sourceString&#160;</td>
    403. 

  403.           <td class="paramname"></td><td>)</td>
    404. 

  404.           <td></td>
    405. 

  405.         </tr>
    406. 

  406.       </table>
    407. 

  407. </div><div class="memdoc">
    408. 

  408. <p>Use the strlwr function to convert all alpha characters in sourceString to lower-case equivalents. </p>
    409. 

  409. <dl class="params"><dt>Parameters</dt><dd>
    410. 

  410.   <table class="params">
    411. 

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

  412.   </table>
    413. 

  413.   </dd>
    414. 

  414. </dl>
    415. 

  415. <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>
    416. 

  416. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga00d04a14fa694517811ee2df409ebd59">strupr</a> </dd></dl>
    417. 

  417. 

  418. </div>
    419. 

  419. </div>
    420. 

  420. <a class="anchor" id="ga2fdd893119d727067a003bef32e57bdd"></a>
    421. 

  421. <div class="memitem">
    422. 

  422. <div class="memproto">
    423. 

  423.       <table class="memname">
    424. 

  424.         <tr>
    425. 

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

  426.           <td>(</td>
    427. 

  427.           <td class="paramtype">sourceString&#160;</td>
    428. 

  428.           <td class="paramname">, </td>
    429. 

  429.         </tr>
    430. 

  430.         <tr>
    431. 

  431.           <td class="paramkey"></td>
    432. 

  432.           <td></td>
    433. 

  433.           <td class="paramtype">searchString&#160;</td>
    434. 

  434.           <td class="paramname">, </td>
    435. 

  435.         </tr>
    436. 

  436.         <tr>
    437. 

  437.           <td class="paramkey"></td>
    438. 

  438.           <td></td>
    439. 

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

  440.           <td class="paramname">&#160;</td>
    441. 

  441.         </tr>
    442. 

  442.         <tr>
    443. 

  443.           <td></td>
    444. 

  444.           <td>)</td>
    445. 

  445.           <td></td><td></td>
    446. 

  446.         </tr>
    447. 

  447.       </table>
    448. 

  448. </div><div class="memdoc">
    449. 

  449. <p>Use the strPos function to locate the first instance of searchString in sourceString, starting at character 0, or at an optional offset. </p>
    450. 

  450. <dl class="params"><dt>Parameters</dt><dd>
    451. 

  451.   <table class="params">
    452. 

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

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

  454.     <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>
    455. 

  455.   </table>
    456. 

  456.   </dd>
    457. 

  457. </dl>
    458. 

  458. <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>
    459. 

  459. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> </dd></dl>
    460. 

  460. 

  461. </div>
    462. 

  462. </div>
    463. 

  463. <a class="anchor" id="ga29ce3d394e74b71a57109211835ab0c3"></a>
    464. 

  464. <div class="memitem">
    465. 

  465. <div class="memproto">
    466. 

  466.       <table class="memname">
    467. 

  467.         <tr>
    468. 

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

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

  470.           <td class="paramtype">sourceString&#160;</td>
    471. 

  471.           <td class="paramname">, </td>
    472. 

  472.         </tr>
    473. 

  473.         <tr>
    474. 

  474.           <td class="paramkey"></td>
    475. 

  475.           <td></td>
    476. 

  476.           <td class="paramtype">char&#160;</td>
    477. 

  477.           <td class="paramname">&#160;</td>
    478. 

  478.         </tr>
    479. 

  479.         <tr>
    480. 

  480.           <td></td>
    481. 

  481.           <td>)</td>
    482. 

  482.           <td></td><td></td>
    483. 

  483.         </tr>
    484. 

  484.       </table>
    485. 

  485. </div><div class="memdoc">
    486. 

  486. <p>strrchr searches the sourceString for the last occurance of the giuven char </p>
    487. 

  487. <dl class="params"><dt>Parameters</dt><dd>
    488. 

  488.   <table class="params">
    489. 

  489.     <tr><td class="paramname">sourceString</td><td>The string to search </td></tr>
    490. 

  490.   </table>
    491. 

  491.   </dd>
    492. 

  492. </dl>
    493. 

  493. <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>
    494. 

  494. 

  495. </div>
    496. 

  496. </div>
    497. 

  497. <a class="anchor" id="ga4e1268b2e16a57b6967d5246b5e8dbb0"></a>
    498. 

  498. <div class="memitem">
    499. 

  499. <div class="memproto">
    500. 

  500.       <table class="memname">
    501. 

  501.         <tr>
    502. 

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

  503.           <td>(</td>
    504. 

  504.           <td class="paramtype">sourceString&#160;</td>
    505. 

  505.           <td class="paramname">, </td>
    506. 

  506.         </tr>
    507. 

  507.         <tr>
    508. 

  508.           <td class="paramkey"></td>
    509. 

  509.           <td></td>
    510. 

  510.           <td class="paramtype">from&#160;</td>
    511. 

  511.           <td class="paramname">, </td>
    512. 

  512.         </tr>
    513. 

  513.         <tr>
    514. 

  514.           <td class="paramkey"></td>
    515. 

  515.           <td></td>
    516. 

  516.           <td class="paramtype">to&#160;</td>
    517. 

  517.           <td class="paramname">&#160;</td>
    518. 

  518.         </tr>
    519. 

  519.         <tr>
    520. 

  520.           <td></td>
    521. 

  521.           <td>)</td>
    522. 

  522.           <td></td><td></td>
    523. 

  523.         </tr>
    524. 

  524.       </table>
    525. 

  525. </div><div class="memdoc">
    526. 

  526. <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>
    527. 

  527. <dl class="params"><dt>Parameters</dt><dd>
    528. 

  528.   <table class="params">
    529. 

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

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

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

  532.   </table>
    533. 

  533.   </dd>
    534. 

  534. </dl>
    535. 

  535. <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>
    536. 

  536. 

  537. </div>
    538. 

  538. </div>
    539. 

  539. <a class="anchor" id="gae9f5ef43b0385406834f79bdea12aec6"></a>
    540. 

  540. <div class="memitem">
    541. 

  541. <div class="memproto">
    542. 

  542.       <table class="memname">
    543. 

  543.         <tr>
    544. 

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

  545.           <td>(</td>
    546. 

  546.           <td class="paramtype">sourceString&#160;</td>
    547. 

  547.           <td class="paramname">, </td>
    548. 

  548.         </tr>
    549. 

  549.         <tr>
    550. 

  550.           <td class="paramkey"></td>
    551. 

  551.           <td></td>
    552. 

  552.           <td class="paramtype">searchString&#160;</td>
    553. 

  553.           <td class="paramname">&#160;</td>
    554. 

  554.         </tr>
    555. 

  555.         <tr>
    556. 

  556.           <td></td>
    557. 

  557.           <td>)</td>
    558. 

  558.           <td></td><td></td>
    559. 

  559.         </tr>
    560. 

  560.       </table>
    561. 

  561. </div><div class="memdoc">
    562. 

  562. <p>Use the strstr function to locate the first instance of searchString in sourceString. </p>
    563. 

  563. <dl class="params"><dt>Parameters</dt><dd>
    564. 

  564.   <table class="params">
    565. 

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

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

  567.   </table>
    568. 

  568.   </dd>
    569. 

  569. </dl>
    570. 

  570. <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>
    571. 

  571. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga2fdd893119d727067a003bef32e57bdd">strpos</a> </dd></dl>
    572. 

  572. 

  573. </div>
    574. 

  574. </div>
    575. 

  575. <a class="anchor" id="ga00d04a14fa694517811ee2df409ebd59"></a>
    576. 

  576. <div class="memitem">
    577. 

  577. <div class="memproto">
    578. 

  578.       <table class="memname">
    579. 

  579.         <tr>
    580. 

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

  581.           <td>(</td>
    582. 

  582.           <td class="paramtype">sourceString&#160;</td>
    583. 

  583.           <td class="paramname"></td><td>)</td>
    584. 

  584.           <td></td>
    585. 

  585.         </tr>
    586. 

  586.       </table>
    587. 

  587. </div><div class="memdoc">
    588. 

  588. <p>Use the strupr function to convert all alpha characters in sourceString to upper-case equivalents. </p>
    589. 

  589. <dl class="params"><dt>Parameters</dt><dd>
    590. 

  590.   <table class="params">
    591. 

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

  592.   </table>
    593. 

  593.   </dd>
    594. 

  594. </dl>
    595. 

  595. <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>
    596. 

  596. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga4ca39bba5a20c2b54cbf832c86825b9f">strlwr</a> </dd></dl>
    597. 

  597. 

  598. </div>
    599. 

  599. </div>
    600. 

  600. <a class="anchor" id="ga61510d39195c7eaab61a609b02c91f74"></a>
    601. 

  601. <div class="memitem">
    602. 

  602. <div class="memproto">
    603. 

  603.       <table class="memname">
    604. 

  604.         <tr>
    605. 

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

  606.           <td>(</td>
    607. 

  607.           <td class="paramtype">sourceString&#160;</td>
    608. 

  608.           <td class="paramname"></td><td>)</td>
    609. 

  609.           <td></td>
    610. 

  610.         </tr>
    611. 

  611.       </table>
    612. 

  612. </div><div class="memdoc">
    613. 

  613. <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>
    614. 

  614. <dl class="params"><dt>Parameters</dt><dd>
    615. 

  615.   <table class="params">
    616. 

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

  617.   </table>
    618. 

  618.   </dd>
    619. 

  619. </dl>
    620. 

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

  621. <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>
    622. 

  622. 

  623. </div>
    624. 

  624. </div>
    625. 

  625. </div><!-- contents -->
    626. 

  626. <!-- start footer part -->
    627. 

  627. <hr class="footer"/><address class="footer"><small>
    628. 

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

  629. <img class="footer" src="doxygen.png" alt="doxygen"/>
    630. 

  630. </a> 1.8.3.1
    631. 

  631. </small></address>
    632. 

  632. </body>
    633. 

  633. </html>
    634.