PageRenderTime 41ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/commands/SetExpression.htm

https://github.com/Lexikos/AutoHotkey_L-Docs
HTML | 70 lines | 59 code | 11 blank | 0 comment | 0 complexity | b2a4471ec2fe241a70f710ef1e9e2c2a MD5 | raw file
    

  1. <!DOCTYPE HTML>
    2. 

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

  3. <head>
    4. 

  4. <title>Var := Expression - Syntax &amp; Usage | AutoHotkey</title>
    5. 

  5. <meta name="description" content="The &quot;Var := Expression&quot; statement evaluates an expression and stores the result in a variable." />
    6. 

  6. <meta name="ahk:equiv-v2" content="Variables.htm#AssignOp" />
    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>Var := expression</h1>
    15. 

  15. 

  16. <p>Evaluates an expression and stores the result in a <a href="../Variables.htm">variable</a>.</p>
    17. 

  17. 

  18. <pre class="Syntax">Var := expression</pre>
    19. 

  19. <h2 id="Parameters">Parameters</h2>
    20. 

  20. <dl>
    21. 

  21. 

  22.   <dt>Var</dt>
    23. 

  23.   <dd><p>The name of the <a href="../Variables.htm">variable</a> in which to store the result of <em>expression</em>.</p></dd>
    24. 

  24. 

  25.   <dt>Expression</dt>
    26. 

  26.   <dd><p>See <a href="../Variables.htm#Expressions">expressions</a> and the examples below for details.</p></dd>
    27. 

  27. 

  28. </dl>
    29. 

  29. 

  30. <h2 id="Remarks">Remarks</h2>
    31. 

  31. <p>The := operator is optimized so that it performs just as quickly as the = operator for simple cases such as the following:</p>
    32. 

  32. <pre>x := y  <em>; Same performance as x = %y%</em>
    33. 

  33. x := 5  <em>; Same performance as x = 5.</em>
    34. 

  34. x := "literal string"  <em>; Same performance as x = literal string.</em></pre>
    35. 

  35. <p>The words <code>true</code> and <code>false</code> are built-in constants containing 1 and 0. They can be used to make a script more readable as in these examples:</p>
    36. 

  36. <pre>CaseSensitive := false
    37. 

  37. ContinueSearch := true</pre>
    38. 

  38. <p>It is possible to create a <a href="../misc/Arrays.htm#pseudo">pseudo-array</a> with this command and any others that accept an <em>OutputVar</em>. This is done by making <em>OutputVar</em> contain a reference to another variable, e.g. <code>Array%i% := Var/100 + 5</code>. See <a href="../misc/Arrays.htm">Arrays</a> for more information.</p>
    39. 

  39. <h2 id="Related">Related</h2>
    40. 

  40. <p><a href="../Variables.htm#Expressions">Expressions</a>, <a href="IfExpression.htm">If (expression)</a>, <a href="../Functions.htm">Functions</a>, <a href="SetEnv.htm">SetEnv</a>, <a href="EnvSet.htm">EnvSet</a>, <a href="EnvAdd.htm">EnvAdd</a>, <a href="EnvSub.htm">EnvSub</a>, <a href="EnvMult.htm">EnvMult</a>, <a href="EnvDiv.htm">EnvDiv</a>, <a href="IfEqual.htm">If (legacy)</a>, <a href="../misc/Arrays.htm">Arrays</a></p>
    41. 

  41. <h2 id="Examples">Examples</h2>
    42. 

  42. <div class="ex" id="ExString">
    43. 

  43. <p><a class="ex_number" href="#ExString"></a> Assigns a literal string to a variable.</p>
    44. 

  44. <pre>Var := "literal string"</pre>
    45. 

  45. </div>
    46. 

  46. 

  47. <div class="ex" id="ExNumber">
    48. 

  48. <p><a class="ex_number" href="#ExNumber"></a> Assigns a number to a variable.</p>
    49. 

  49. <pre>Var := 3</pre>
    50. 

  50. </div>
    51. 

  51. 

  52. <div class="ex" id="ExMath">
    53. 

  53. <p><a class="ex_number" href="#ExMath"></a> Calculates the net price and stores the result in <var>Var</var>.</p>
    54. 

  54. <pre>Var := Price * (1 - Discount/100)</pre>
    55. 

  55. </div>
    56. 

  56. 

  57. <div class="ex" id="ExBoolean">
    58. 

  58. <p><a class="ex_number" href="#ExBoolean"></a> Determines the truth of an expression and stores the result (1 for true or 0 for false) in <var>Finished</var>.</p>
    59. 

  59. <pre>Finished := not Done or A_Index &gt; 100
    60. 

  60. if not Finished
    61. 

  61. {
    62. 

  62.     FileAppend, %NewText%`n, %TargetFile%
    63. 

  63.     return
    64. 

  64. }
    65. 

  65. else
    66. 

  66.     ExitApp</pre>
    67. 

  67. </div>
    68. 

    69. 

  69. </body>
    70. 

  70. </html>
    71. 

    72.