/docs/commands/StringLen.htm

http://github.com/Lexikos/AutoHotkey_L-Docs · HTML · 61 lines · 46 code · 15 blank · 0 comment · 0 complexity · 0a892913e2ec3a6b48a419d3495cfccb MD5 · raw file 

    

  1. <!DOCTYPE HTML>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. <title>StrLen() / StringLen - Syntax &amp; Usage | AutoHotkey</title>
    5. 

  5. <meta name="description" content="The StrLen function and StringLen command retrieve the count of how many characters are in a string." />
    6. 

  6. <meta name="ahk:equiv-v2" content="commands/StrLen.htm" />
    7. 

  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    8. 

  8. <meta http-equiv="X-UA-Compatible" content="IE=edge">
    9. 

  9. <link href="../static/theme.css" rel="stylesheet" type="text/css" />
    10. 

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

  11. </head>
    12. 

  12. <body>
    13. 

  13. 

  14. <h1>StrLen() / StringLen</h1>
    15. 

  15. 

  16. <p>Retrieves the count of how many characters are in a string.</p>
    17. 

  17. 

  18. <h2 id="function">StrLen()</h2>
    19. 

  19. 

  20. <pre class="Syntax">Length := <span class="func">StrLen</span>(String)</pre>
    21. 

  21. <h3>Parameters</h3>
    22. 

  22. <dl>
    23. 

  23. 

  24.   <dt>String</dt>
    25. 

  25.   <dd><p>The string to be measured.</p></dd>
    26. 

  26. 

  27. </dl>
    28. 

  28. 

  29. <h3>Return Value</h3>
    30. 

  30. <p>This function returns the length of the string.</p>
    31. 

  31. 

  32. <h3>Examples</h3>
    33. 

  33. <pre class="NoIndent">InputVar := "The Quick Brown Fox Jumps Over the Lazy Dog"
    34. 

  34. MsgBox % &quot;The length of InputVar is &quot; . StrLen(InputVar) <em>; Result: 43</em></pre>
    35. 

  35. <h2 id="command">StringLen</h2>
    36. 

  36. <p class="warning"><strong>Deprecated:</strong> This command is not recommended for use in new scripts. Use the <a href="#function">StrLen</a> function instead.</p>
    37. 

  37. 

  38. <pre class="Syntax"><span class="func">StringLen</span>, OutputVar, InputVar</pre>
    39. 

  39. <h3>Parameters</h3>
    40. 

  40. <dl>
    41. 

  41. 

  42.   <dt>OutputVar</dt>
    43. 

  43.   <dd><p>The name of the variable in which to store the length.</p></dd>
    44. 

  44. 

  45.   <dt>InputVar</dt>
    46. 

  46.   <dd><p>The name of the variable whose contents will be measured. Do not enclose the name in percent signs unless you want the <em>contents</em> of the variable to be used as the name.</p>
    47. 

  47.   </dd>
    48. 

  48. 

  49. </dl>
    50. 

  50. 

  51. <h3>Examples</h3>
    52. 

  52. <pre class="NoIndent">StringLen, Length, InputVar
    53. 

  53. MsgBox, The length of InputVar is %Length%.</pre>
    54. 

  54. 

  55. <h2>Remarks</h2>
    56. 

  56. <p>If <em>String</em> or <em>InputVar</em> is a variable to which <a href="../misc/Clipboard.htm#ClipboardAll">ClipboardAll</a> was previously assigned, StrLen() or StringLen will report its total size.</p>
    57. 

  57. <h2>Related</h2>
    58. 

  58. <p><a href="IfInString.htm">IfInString</a>, <a href="StringGetPos.htm">StringGetPos</a>, <a href="StringMid.htm">StringMid</a>, <a href="StringTrimLeft.htm">StringTrimLeft</a>, <a href="StringTrimLeft.htm">StringTrimRight</a>, <a href="StringLeft.htm">StringLeft</a>, <a href="StringLeft.htm">StringRight</a>, <a href="StringLower.htm">StringLower</a>, <a href="StringLower.htm">StringUpper</a>, <a href="StringReplace.htm">StringReplace</a></p>
    59. 

  59. 

  60. </body>
    61. 

  61. </html>
    62.