Home Explore Help
Sign In
TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 889f61e63c
Branches Tags
Torque2D
/
TorqueScriptDocs
/
html
/
group__StringFunctions.html

group__StringFunctions.html 30 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616 
  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. <title>StringFunctions</title>
    6. 

  6. <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
    7. 

  7. </head>
    8. 

  8. <body>
    9. 

  9. <table width="100%" class="header">
    10. 

  10. <tr>
    11. 

  11. </tr>
    12. 

  12. <tr><td class="headermenu">
    13. 

  13. 	<center>
    14. 

  14. 	<a class="qindex" href="index.html">Main</a> &nbsp; 
    15. 

  15. 	<a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
    16. 

  16. 	</center>
    17. 

  17. </td></tr>
    18. 

  18. </table>
    19. 

  19. <br>
    20. 

  20. <!-- END HEADER -->
    21. 

  21. <!-- Generated by Doxygen 1.8.3.1 -->
    22. 

  22. </div><!-- top -->
    23. 

  23. <div class="header">
    24. 

  24.   <div class="summary">
    25. 

  25. <a href="#func-members">Functions</a>  </div>
    26. 

  26.   <div class="headertitle">
    27. 

  27. <div class="title">StringFunctions</div>  </div>
    28. 

  28. </div><!--header-->
    29. 

  29. <div class="contents">
    30. 

  30. <table class="memberdecls">
    31. 

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

  32. Functions</h2></td></tr>
    33. 

  33. <tr class="memitem:ga5f48daa7fce72b90442a216c765d6bdf"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga5f48daa7fce72b90442a216c765d6bdf">getSubStr</a> (sourceString, start, count)</td></tr>
    34. 

  34. <tr class="separator:ga5f48daa7fce72b90442a216c765d6bdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
    35. 

  35. <tr class="memitem:gaa2d4cbcd875a862583bbcfb52f506778"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gaa2d4cbcd875a862583bbcfb52f506778">ltrim</a> (sourceString)</td></tr>
    36. 

  36. <tr class="separator:gaa2d4cbcd875a862583bbcfb52f506778"><td class="memSeparator" colspan="2">&#160;</td></tr>
    37. 

  37. <tr class="memitem:gac243cb794c138686d8815e7a6bee16ac"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gac243cb794c138686d8815e7a6bee16ac">rtrim</a> (sourceString)</td></tr>
    38. 

  38. <tr class="separator:gac243cb794c138686d8815e7a6bee16ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
    39. 

  39. <tr class="memitem:gafeb3105f298e91e024a49e079a8c0b35"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gafeb3105f298e91e024a49e079a8c0b35">strchr</a> (sourceString, char)</td></tr>
    40. 

  40. <tr class="separator:gafeb3105f298e91e024a49e079a8c0b35"><td class="memSeparator" colspan="2">&#160;</td></tr>
    41. 

  41. <tr class="memitem:gaad2609198aaa90f3b10cd4dc2c1a1179"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gaad2609198aaa90f3b10cd4dc2c1a1179">strcmp</a> (string1, string2)</td></tr>
    42. 

  42. <tr class="separator:gaad2609198aaa90f3b10cd4dc2c1a1179"><td class="memSeparator" colspan="2">&#160;</td></tr>
    43. 

  43. <tr class="memitem:ga50a88d8ebcc9770ff650702a87cd1ad7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga50a88d8ebcc9770ff650702a87cd1ad7">stricmp</a> (string1, string2)</td></tr>
    44. 

  44. <tr class="separator:ga50a88d8ebcc9770ff650702a87cd1ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    45. 

  45. <tr class="memitem:ga48727324067f97fd6b4616d937ef9a4b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga48727324067f97fd6b4616d937ef9a4b">stripChars</a> (sourceString, chars)</td></tr>
    46. 

  46. <tr class="separator:ga48727324067f97fd6b4616d937ef9a4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    47. 

  47. <tr class="memitem:ga146ae3c476d936ea665c110715213ea1"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga146ae3c476d936ea665c110715213ea1">stripColorCodes</a> (stringtoStrip)</td></tr>
    48. 

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

  49. <tr class="memitem:gaca73d027cec9a2364002cb24aa754f30"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#gaca73d027cec9a2364002cb24aa754f30">stripTrailingSpaces</a> (string)</td></tr>
    50. 

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

  51. <tr class="memitem:ga600bee88d2c93c576a6612a456e54c9f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga600bee88d2c93c576a6612a456e54c9f">strlen</a> (string)</td></tr>
    52. 

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

  53. <tr class="memitem:ga60832291826e945adb67cc8a8cce1d5d"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga60832291826e945adb67cc8a8cce1d5d">strlwr</a> (sourceString)</td></tr>
    54. 

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

  55. <tr class="memitem:ga0802323faf674cf3fc449578608e7420"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga0802323faf674cf3fc449578608e7420">strpos</a> (sourceString, searchString[, offset])</td></tr>
    56. 

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

  57. <tr class="memitem:ga33f5fb9ab5fa3cadadda62fc87c21539"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga33f5fb9ab5fa3cadadda62fc87c21539">strrchr</a> (sourceString, char)</td></tr>
    58. 

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

  59. <tr class="memitem:ga146f35ce7d441fdddcd678b574140c57"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga146f35ce7d441fdddcd678b574140c57">strreplace</a> (sourceString, from, to)</td></tr>
    60. 

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

  61. <tr class="memitem:ga717e6af228d96d6abb2f8853963e5871"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga717e6af228d96d6abb2f8853963e5871">strstr</a> (sourceString, searchString)</td></tr>
    62. 

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

  63. <tr class="memitem:ga73a34a5b1d313b47cc27a55e9ffc66a9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga73a34a5b1d313b47cc27a55e9ffc66a9">strupr</a> (sourceString)</td></tr>
    64. 

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

  65. <tr class="memitem:ga467af310079045104f25cfeb6f20b3d9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StringFunctions.html#ga467af310079045104f25cfeb6f20b3d9">trim</a> (sourceString)</td></tr>
    66. 

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

  67. </table>
    68. 

  68. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    69. 

  69. <p>General string manipulation functions. </p>
    70. 

  70. <h2 class="groupheader">Function Documentation</h2>
    71. 

  71. <a class="anchor" id="ga5f48daa7fce72b90442a216c765d6bdf"></a>
    72. 

  72. <div class="memitem">
    73. 

  73. <div class="memproto">
    74. 

  74.       <table class="memname">
    75. 

  75.         <tr>
    76. 

  76.           <td class="memname">string getSubStr </td>
    77. 

  77.           <td>(</td>
    78. 

  78.           <td class="paramtype">sourceString&#160;</td>
    79. 

  79.           <td class="paramname">, </td>
    80. 

  80.         </tr>
    81. 

  81.         <tr>
    82. 

  82.           <td class="paramkey"></td>
    83. 

  83.           <td></td>
    84. 

  84.           <td class="paramtype">start&#160;</td>
    85. 

  85.           <td class="paramname">, </td>
    86. 

  86.         </tr>
    87. 

  87.         <tr>
    88. 

  88.           <td class="paramkey"></td>
    89. 

  89.           <td></td>
    90. 

  90.           <td class="paramtype">count&#160;</td>
    91. 

  91.           <td class="paramname">&#160;</td>
    92. 

  92.         </tr>
    93. 

  93.         <tr>
    94. 

  94.           <td></td>
    95. 

  95.           <td>)</td>
    96. 

  96.           <td></td><td></td>
    97. 

  97.         </tr>
    98. 

  98.       </table>
    99. 

  99. </div><div class="memdoc">
    100. 

  100. <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>
    101. 

  101. <dl class="params"><dt>Parameters</dt><dd>
    102. 

  102.   <table class="params">
    103. 

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

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

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

  106.   </table>
    107. 

  107.   </dd>
    108. 

  108. </dl>
    109. 

  109. <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>
    110. 

  110. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#gafeb3105f298e91e024a49e079a8c0b35">strchr</a> </dd></dl>
    111. 

  111. 

  112. </div>
    113. 

  113. </div>
    114. 

  114. <a class="anchor" id="gaa2d4cbcd875a862583bbcfb52f506778"></a>
    115. 

  115. <div class="memitem">
    116. 

  116. <div class="memproto">
    117. 

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

  118.         <tr>
    119. 

  119.           <td class="memname">string ltrim </td>
    120. 

  120.           <td>(</td>
    121. 

  121.           <td class="paramtype">sourceString&#160;</td>
    122. 

  122.           <td class="paramname"></td><td>)</td>
    123. 

  123.           <td></td>
    124. 

  124.         </tr>
    125. 

  125.       </table>
    126. 

  126. </div><div class="memdoc">
    127. 

  127. <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>
    128. 

  128. <dl class="params"><dt>Parameters</dt><dd>
    129. 

  129.   <table class="params">
    130. 

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

  131.   </table>
    132. 

  132.   </dd>
    133. 

  133. </dl>
    134. 

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

  135. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga48727324067f97fd6b4616d937ef9a4b">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaca73d027cec9a2364002cb24aa754f30">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#gac243cb794c138686d8815e7a6bee16ac">rtrim</a>, <a class="el" href="group__StringFunctions.html#ga467af310079045104f25cfeb6f20b3d9">trim</a> </dd></dl>
    136. 

  136. 

  137. </div>
    138. 

  138. </div>
    139. 

  139. <a class="anchor" id="gac243cb794c138686d8815e7a6bee16ac"></a>
    140. 

  140. <div class="memitem">
    141. 

  141. <div class="memproto">
    142. 

  142.       <table class="memname">
    143. 

  143.         <tr>
    144. 

  144.           <td class="memname">string rtrim </td>
    145. 

  145.           <td>(</td>
    146. 

  146.           <td class="paramtype">sourceString&#160;</td>
    147. 

  147.           <td class="paramname"></td><td>)</td>
    148. 

  148.           <td></td>
    149. 

  149.         </tr>
    150. 

  150.       </table>
    151. 

  151. </div><div class="memdoc">
    152. 

  152. <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>
    153. 

  153. <dl class="params"><dt>Parameters</dt><dd>
    154. 

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

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

  156.   </table>
    157. 

  157.   </dd>
    158. 

  158. </dl>
    159. 

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

  160. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga48727324067f97fd6b4616d937ef9a4b">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaca73d027cec9a2364002cb24aa754f30">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#gaa2d4cbcd875a862583bbcfb52f506778">ltrim</a>, <a class="el" href="group__StringFunctions.html#ga467af310079045104f25cfeb6f20b3d9">trim</a> </dd></dl>
    161. 

  161. 

  162. </div>
    163. 

  163. </div>
    164. 

  164. <a class="anchor" id="gafeb3105f298e91e024a49e079a8c0b35"></a>
    165. 

  165. <div class="memitem">
    166. 

  166. <div class="memproto">
    167. 

  167.       <table class="memname">
    168. 

  168.         <tr>
    169. 

  169.           <td class="memname">string strchr </td>
    170. 

  170.           <td>(</td>
    171. 

  171.           <td class="paramtype">sourceString&#160;</td>
    172. 

  172.           <td class="paramname">, </td>
    173. 

  173.         </tr>
    174. 

  174.         <tr>
    175. 

  175.           <td class="paramkey"></td>
    176. 

  176.           <td></td>
    177. 

  177.           <td class="paramtype">char&#160;</td>
    178. 

  178.           <td class="paramname">&#160;</td>
    179. 

  179.         </tr>
    180. 

  180.         <tr>
    181. 

  181.           <td></td>
    182. 

  182.           <td>)</td>
    183. 

  183.           <td></td><td></td>
    184. 

  184.         </tr>
    185. 

  185.       </table>
    186. 

  186. </div><div class="memdoc">
    187. 

  187. <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>
    188. 

  188. <dl class="params"><dt>Parameters</dt><dd>
    189. 

  189.   <table class="params">
    190. 

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

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

  192.   </table>
    193. 

  193.   </dd>
    194. 

  194. </dl>
    195. 

  195. <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>
    196. 

  196. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga5f48daa7fce72b90442a216c765d6bdf">getSubStr</a> </dd></dl>
    197. 

  197. 

  198. </div>
    199. 

  199. </div>
    200. 

  200. <a class="anchor" id="gaad2609198aaa90f3b10cd4dc2c1a1179"></a>
    201. 

  201. <div class="memitem">
    202. 

  202. <div class="memproto">
    203. 

  203.       <table class="memname">
    204. 

  204.         <tr>
    205. 

  205.           <td class="memname">int strcmp </td>
    206. 

  206.           <td>(</td>
    207. 

  207.           <td class="paramtype">string1&#160;</td>
    208. 

  208.           <td class="paramname">, </td>
    209. 

  209.         </tr>
    210. 

  210.         <tr>
    211. 

  211.           <td class="paramkey"></td>
    212. 

  212.           <td></td>
    213. 

  213.           <td class="paramtype">string2&#160;</td>
    214. 

  214.           <td class="paramname">&#160;</td>
    215. 

  215.         </tr>
    216. 

  216.         <tr>
    217. 

  217.           <td></td>
    218. 

  218.           <td>)</td>
    219. 

  219.           <td></td><td></td>
    220. 

  220.         </tr>
    221. 

  221.       </table>
    222. 

  222. </div><div class="memdoc">
    223. 

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

  224. <dl class="params"><dt>Parameters</dt><dd>
    225. 

  225.   <table class="params">
    226. 

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

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

  228.   </table>
    229. 

  229.   </dd>
    230. 

  230. </dl>
    231. 

  231. <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>
    232. 

  232. <dl class="section see"><dt>See Also</dt><dd>see <a class="el" href="group__StringFunctions.html#ga50a88d8ebcc9770ff650702a87cd1ad7">stricmp</a>, <a class="el" href="group__StringFunctions.html#ga717e6af228d96d6abb2f8853963e5871">strstr</a> </dd></dl>
    233. 

  233. 

  234. </div>
    235. 

  235. </div>
    236. 

  236. <a class="anchor" id="ga50a88d8ebcc9770ff650702a87cd1ad7"></a>
    237. 

  237. <div class="memitem">
    238. 

  238. <div class="memproto">
    239. 

  239.       <table class="memname">
    240. 

  240.         <tr>
    241. 

  241.           <td class="memname">int stricmp </td>
    242. 

  242.           <td>(</td>
    243. 

  243.           <td class="paramtype">string1&#160;</td>
    244. 

  244.           <td class="paramname">, </td>
    245. 

  245.         </tr>
    246. 

  246.         <tr>
    247. 

  247.           <td class="paramkey"></td>
    248. 

  248.           <td></td>
    249. 

  249.           <td class="paramtype">string2&#160;</td>
    250. 

  250.           <td class="paramname">&#160;</td>
    251. 

  251.         </tr>
    252. 

  252.         <tr>
    253. 

  253.           <td></td>
    254. 

  254.           <td>)</td>
    255. 

  255.           <td></td><td></td>
    256. 

  256.         </tr>
    257. 

  257.       </table>
    258. 

  258. </div><div class="memdoc">
    259. 

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

  260. <dl class="params"><dt>Parameters</dt><dd>
    261. 

  261.   <table class="params">
    262. 

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

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

  264.   </table>
    265. 

  265.   </dd>
    266. 

  266. </dl>
    267. 

  267. <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>
    268. 

  268. <dl class="section see"><dt>See Also</dt><dd>see <a class="el" href="group__StringFunctions.html#gaad2609198aaa90f3b10cd4dc2c1a1179">strcmp</a>, <a class="el" href="group__StringFunctions.html#ga717e6af228d96d6abb2f8853963e5871">strstr</a> </dd></dl>
    269. 

  269. 

  270. </div>
    271. 

  271. </div>
    272. 

  272. <a class="anchor" id="ga48727324067f97fd6b4616d937ef9a4b"></a>
    273. 

  273. <div class="memitem">
    274. 

  274. <div class="memproto">
    275. 

  275.       <table class="memname">
    276. 

  276.         <tr>
    277. 

  277.           <td class="memname">string stripChars </td>
    278. 

  278.           <td>(</td>
    279. 

  279.           <td class="paramtype">sourceString&#160;</td>
    280. 

  280.           <td class="paramname">, </td>
    281. 

  281.         </tr>
    282. 

  282.         <tr>
    283. 

  283.           <td class="paramkey"></td>
    284. 

  284.           <td></td>
    285. 

  285.           <td class="paramtype">chars&#160;</td>
    286. 

  286.           <td class="paramname">&#160;</td>
    287. 

  287.         </tr>
    288. 

  288.         <tr>
    289. 

  289.           <td></td>
    290. 

  290.           <td>)</td>
    291. 

  291.           <td></td><td></td>
    292. 

  292.         </tr>
    293. 

  293.       </table>
    294. 

  294. </div><div class="memdoc">
    295. 

  295. <p>Use the stripChars function to remove chars from sourceString. </p>
    296. 

  296. <dl class="params"><dt>Parameters</dt><dd>
    297. 

  297.   <table class="params">
    298. 

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

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

  300.   </table>
    301. 

  301.   </dd>
    302. 

  302. </dl>
    303. 

  303. <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>
    304. 

  304. <dl class="section see"><dt>See Also</dt><dd>stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaca73d027cec9a2364002cb24aa754f30">stripTrailingSpaces</a> </dd></dl>
    305. 

  305. 

  306. </div>
    307. 

  307. </div>
    308. 

  308. <a class="anchor" id="ga146ae3c476d936ea665c110715213ea1"></a>
    309. 

  309. <div class="memitem">
    310. 

  310. <div class="memproto">
    311. 

  311.       <table class="memname">
    312. 

  312.         <tr>
    313. 

  313.           <td class="memname">string stripColorCodes </td>
    314. 

  314.           <td>(</td>
    315. 

  315.           <td class="paramtype">stringtoStrip&#160;</td>
    316. 

  316.           <td class="paramname"></td><td>)</td>
    317. 

  317.           <td></td>
    318. 

  318.         </tr>
    319. 

  319.       </table>
    320. 

  320. </div><div class="memdoc">
    321. 

  321. <ul>
    322. 

  322. <li>remove TorqueML color codes from the string. <dl class="params"><dt>Parameters</dt><dd>
    323. 

  323.   <table class="params">
    324. 

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

  325.   </table>
    326. 

  326.   </dd>
    327. 

  327. </dl>
    328. 

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

  329. </li>
    330. 

  330. </ul>
    331. 

  331. 

  332. </div>
    333. 

  333. </div>
    334. 

  334. <a class="anchor" id="gaca73d027cec9a2364002cb24aa754f30"></a>
    335. 

  335. <div class="memitem">
    336. 

  336. <div class="memproto">
    337. 

  337.       <table class="memname">
    338. 

  338.         <tr>
    339. 

  339.           <td class="memname">string stripTrailingSpaces </td>
    340. 

  340.           <td>(</td>
    341. 

  341.           <td class="paramtype">string&#160;</td>
    342. 

  342.           <td class="paramname"></td><td>)</td>
    343. 

  343.           <td></td>
    344. 

  344.         </tr>
    345. 

  345.       </table>
    346. 

  346. </div><div class="memdoc">
    347. 

  347. <p>Removes all spaces after the final </p>
    348. 

  348. <dl class="params"><dt>Parameters</dt><dd>
    349. 

  349.   <table class="params">
    350. 

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

  351.   </table>
    352. 

  352.   </dd>
    353. 

  353. </dl>
    354. 

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

  355. 

  356. </div>
    357. 

  357. </div>
    358. 

  358. <a class="anchor" id="ga600bee88d2c93c576a6612a456e54c9f"></a>
    359. 

  359. <div class="memitem">
    360. 

  360. <div class="memproto">
    361. 

  361.       <table class="memname">
    362. 

  362.         <tr>
    363. 

  363.           <td class="memname">int strlen </td>
    364. 

  364.           <td>(</td>
    365. 

  365.           <td class="paramtype">string&#160;</td>
    366. 

  366.           <td class="paramname"></td><td>)</td>
    367. 

  367.           <td></td>
    368. 

  368.         </tr>
    369. 

  369.       </table>
    370. 

  370. </div><div class="memdoc">
    371. 

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

  372. <dl class="params"><dt>Parameters</dt><dd>
    373. 

  373.   <table class="params">
    374. 

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

  375.   </table>
    376. 

  376.   </dd>
    377. 

  377. </dl>
    378. 

  378. <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>
    379. 

  379. 

  380. </div>
    381. 

  381. </div>
    382. 

  382. <a class="anchor" id="ga60832291826e945adb67cc8a8cce1d5d"></a>
    383. 

  383. <div class="memitem">
    384. 

  384. <div class="memproto">
    385. 

  385.       <table class="memname">
    386. 

  386.         <tr>
    387. 

  387.           <td class="memname">string strlwr </td>
    388. 

  388.           <td>(</td>
    389. 

  389.           <td class="paramtype">sourceString&#160;</td>
    390. 

  390.           <td class="paramname"></td><td>)</td>
    391. 

  391.           <td></td>
    392. 

  392.         </tr>
    393. 

  393.       </table>
    394. 

  394. </div><div class="memdoc">
    395. 

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

  396. <dl class="params"><dt>Parameters</dt><dd>
    397. 

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

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

  399.   </table>
    400. 

  400.   </dd>
    401. 

  401. </dl>
    402. 

  402. <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>
    403. 

  403. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga73a34a5b1d313b47cc27a55e9ffc66a9">strupr</a> </dd></dl>
    404. 

  404. 

  405. </div>
    406. 

  406. </div>
    407. 

  407. <a class="anchor" id="ga0802323faf674cf3fc449578608e7420"></a>
    408. 

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

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

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

  411.         <tr>
    412. 

  412.           <td class="memname">int strpos </td>
    413. 

  413.           <td>(</td>
    414. 

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

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

  416.         </tr>
    417. 

  417.         <tr>
    418. 

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

  419.           <td></td>
    420. 

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

  421.           <td class="paramname">[, offset]&#160;</td>
    422. 

  422.         </tr>
    423. 

  423.         <tr>
    424. 

  424.           <td></td>
    425. 

  425.           <td>)</td>
    426. 

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

  427.         </tr>
    428. 

  428.       </table>
    429. 

  429. </div><div class="memdoc">
    430. 

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

  431. <dl class="params"><dt>Parameters</dt><dd>
    432. 

  432.   <table class="params">
    433. 

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

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

  435.     <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>
    436. 

  436.   </table>
    437. 

  437.   </dd>
    438. 

  438. </dl>
    439. 

  439. <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>
    440. 

  440. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga717e6af228d96d6abb2f8853963e5871">strstr</a> </dd></dl>
    441. 

  441. 

  442. </div>
    443. 

  443. </div>
    444. 

  444. <a class="anchor" id="ga33f5fb9ab5fa3cadadda62fc87c21539"></a>
    445. 

  445. <div class="memitem">
    446. 

  446. <div class="memproto">
    447. 

  447.       <table class="memname">
    448. 

  448.         <tr>
    449. 

  449.           <td class="memname">string strrchr </td>
    450. 

  450.           <td>(</td>
    451. 

  451.           <td class="paramtype">sourceString&#160;</td>
    452. 

  452.           <td class="paramname">, </td>
    453. 

  453.         </tr>
    454. 

  454.         <tr>
    455. 

  455.           <td class="paramkey"></td>
    456. 

  456.           <td></td>
    457. 

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

  458.           <td class="paramname">&#160;</td>
    459. 

  459.         </tr>
    460. 

  460.         <tr>
    461. 

  461.           <td></td>
    462. 

  462.           <td>)</td>
    463. 

  463.           <td></td><td></td>
    464. 

  464.         </tr>
    465. 

  465.       </table>
    466. 

  466. </div><div class="memdoc">
    467. 

  467. <p>strrchr searches the sourceString for the last occurance of the giuven char </p>
    468. 

  468. <dl class="params"><dt>Parameters</dt><dd>
    469. 

  469.   <table class="params">
    470. 

  470.     <tr><td class="paramname">sourceString</td><td>The string to search </td></tr>
    471. 

  471.   </table>
    472. 

  472.   </dd>
    473. 

  473. </dl>
    474. 

  474. <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>
    475. 

  475. 

  476. </div>
    477. 

  477. </div>
    478. 

  478. <a class="anchor" id="ga146f35ce7d441fdddcd678b574140c57"></a>
    479. 

  479. <div class="memitem">
    480. 

  480. <div class="memproto">
    481. 

  481.       <table class="memname">
    482. 

  482.         <tr>
    483. 

  483.           <td class="memname">string strreplace </td>
    484. 

  484.           <td>(</td>
    485. 

  485.           <td class="paramtype">sourceString&#160;</td>
    486. 

  486.           <td class="paramname">, </td>
    487. 

  487.         </tr>
    488. 

  488.         <tr>
    489. 

  489.           <td class="paramkey"></td>
    490. 

  490.           <td></td>
    491. 

  491.           <td class="paramtype">from&#160;</td>
    492. 

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

  493.         </tr>
    494. 

  494.         <tr>
    495. 

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

  496.           <td></td>
    497. 

  497.           <td class="paramtype">to&#160;</td>
    498. 

  498.           <td class="paramname">&#160;</td>
    499. 

  499.         </tr>
    500. 

  500.         <tr>
    501. 

  501.           <td></td>
    502. 

  502.           <td>)</td>
    503. 

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

  504.         </tr>
    505. 

  505.       </table>
    506. 

  506. </div><div class="memdoc">
    507. 

  507. <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>
    508. 

  508. <dl class="params"><dt>Parameters</dt><dd>
    509. 

  509.   <table class="params">
    510. 

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

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

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

  513.   </table>
    514. 

  514.   </dd>
    515. 

  515. </dl>
    516. 

  516. <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>
    517. 

  517. 

  518. </div>
    519. 

  519. </div>
    520. 

  520. <a class="anchor" id="ga717e6af228d96d6abb2f8853963e5871"></a>
    521. 

  521. <div class="memitem">
    522. 

  522. <div class="memproto">
    523. 

  523.       <table class="memname">
    524. 

  524.         <tr>
    525. 

  525.           <td class="memname">int strstr </td>
    526. 

  526.           <td>(</td>
    527. 

  527.           <td class="paramtype">sourceString&#160;</td>
    528. 

  528.           <td class="paramname">, </td>
    529. 

  529.         </tr>
    530. 

  530.         <tr>
    531. 

  531.           <td class="paramkey"></td>
    532. 

  532.           <td></td>
    533. 

  533.           <td class="paramtype">searchString&#160;</td>
    534. 

  534.           <td class="paramname">&#160;</td>
    535. 

  535.         </tr>
    536. 

  536.         <tr>
    537. 

  537.           <td></td>
    538. 

  538.           <td>)</td>
    539. 

  539.           <td></td><td></td>
    540. 

  540.         </tr>
    541. 

  541.       </table>
    542. 

  542. </div><div class="memdoc">
    543. 

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

  544. <dl class="params"><dt>Parameters</dt><dd>
    545. 

  545.   <table class="params">
    546. 

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

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

  548.   </table>
    549. 

  549.   </dd>
    550. 

  550. </dl>
    551. 

  551. <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>
    552. 

  552. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga0802323faf674cf3fc449578608e7420">strpos</a> </dd></dl>
    553. 

  553. 

  554. </div>
    555. 

  555. </div>
    556. 

  556. <a class="anchor" id="ga73a34a5b1d313b47cc27a55e9ffc66a9"></a>
    557. 

  557. <div class="memitem">
    558. 

  558. <div class="memproto">
    559. 

  559.       <table class="memname">
    560. 

  560.         <tr>
    561. 

  561.           <td class="memname">string strupr </td>
    562. 

  562.           <td>(</td>
    563. 

  563.           <td class="paramtype">sourceString&#160;</td>
    564. 

  564.           <td class="paramname"></td><td>)</td>
    565. 

  565.           <td></td>
    566. 

  566.         </tr>
    567. 

  567.       </table>
    568. 

  568. </div><div class="memdoc">
    569. 

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

  570. <dl class="params"><dt>Parameters</dt><dd>
    571. 

  571.   <table class="params">
    572. 

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

  573.   </table>
    574. 

  574.   </dd>
    575. 

  575. </dl>
    576. 

  576. <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>
    577. 

  577. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga60832291826e945adb67cc8a8cce1d5d">strlwr</a> </dd></dl>
    578. 

  578. 

  579. </div>
    580. 

  580. </div>
    581. 

  581. <a class="anchor" id="ga467af310079045104f25cfeb6f20b3d9"></a>
    582. 

  582. <div class="memitem">
    583. 

  583. <div class="memproto">
    584. 

  584.       <table class="memname">
    585. 

  585.         <tr>
    586. 

  586.           <td class="memname">string trim </td>
    587. 

  587.           <td>(</td>
    588. 

  588.           <td class="paramtype">sourceString&#160;</td>
    589. 

  589.           <td class="paramname"></td><td>)</td>
    590. 

  590.           <td></td>
    591. 

  591.         </tr>
    592. 

  592.       </table>
    593. 

  593. </div><div class="memdoc">
    594. 

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

  595. <dl class="params"><dt>Parameters</dt><dd>
    596. 

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

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

  598.   </table>
    599. 

  599.   </dd>
    600. 

  600. </dl>
    601. 

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

  602. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__StringFunctions.html#ga48727324067f97fd6b4616d937ef9a4b">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaca73d027cec9a2364002cb24aa754f30">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#gaa2d4cbcd875a862583bbcfb52f506778">ltrim</a>, <a class="el" href="group__StringFunctions.html#gac243cb794c138686d8815e7a6bee16ac">rtrim</a> </dd></dl>
    603. 

  603. 

  604. </div>
    605. 

  605. </div>
    606. 

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

  607. <!-- START FOOTER -->
    608. 

  608. <br>
    609. 

  609. <br>
    610. 

  610. <center>
    611. 

  611. 	<div style="color: #777777;">
    612. 

  612. 	Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
    613. 

  613. 	</div>
    614. 

  614. </center>
    615. 

  615. </body>
    616. 

  616. </html>
    617.