/AutoHotkey.docset/Contents/Resources/Documents/commands/SetEnv.htm

https://gitlab.com/ahkscript/Autohotkey.docset · HTML · 43 lines · 35 code · 8 blank · 0 comment · 0 complexity · 74f28b7ea81763366bffb77fcdc258c4 MD5 · raw file 

    

  1. <!DOCTYPE HTML>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>SetEnv</title>
    5. 

  5. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    6. 

  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
    7. 

  7. <link href="../static/theme.css" rel="stylesheet" type="text/css" />
    8. 

  8. <script src="../static/content.js" type="text/javascript"></script>
    9. 

  9. </head>
    10. 

  10. <body>
    11. 

  11. 

  12. <h1>SetEnv (Var = Value)</h1>
    13. 

  13. 

  14. <p>Assigns the specified value to a <a href="../Variables.htm">variable</a>.</p>
    15. 

  15. 

  16. <pre class="Syntax">SetEnv, Var, Value
    17. 

  17. Var = Value</pre>
    18. 

  18. <h3>Parameters</h3>
    19. 

  19. <dl>
    20. 

  20. 

  21.   <dt>Var</dt>
    22. 

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

  23. 

  24.   <dt>Value</dt>
    25. 

  25.   <dd><p>The string or number to store. If the string is long, it can be broken up into several shorter lines by means of a <a href="../Scripts.htm#continuation">continuation section</a>, which might improve readability and maintainability.</p></dd>
    26. 

  26. 

  27. </dl>
    28. 

  28. 

  29. <h3>Remarks</h3>
    30. 

  30. <p>By default, any spaces or tabs at the beginning and end of <em>Value</em> are omitted from <em>Var</em>. To prevent this, use the methods described at <a href="AutoTrim.htm#Off">AutoTrim Off</a>.</p>
    31. 

  31. <p>The name &quot;SetEnv&quot; is misleading and is a holdover from AutoIt v2. Unlike AutoIt v2, AutoHotkey does not store its variables in the environment.  This is because performance would be worse and also because the OS limits the size of each environment variable to 32 KB. Use <a href="EnvSet.htm">EnvSet</a> instead of SetEnv to write to an <a href="../Variables.htm#env">environment variable</a>.</p>
    32. 

  32. <p>The memory occupied by a large variable can be freed by setting it equal to nothing, e.g. <code>Var =</code>.</p>
    33. 

  33. <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>OuputVar</em> contain a reference to another variable, e.g. <code>array%i% = 123</code>. See <a href="../misc/Arrays.htm">Arrays</a> for more details.</p>
    34. 

  34. <h3>Related</h3>
    35. 

  35. <p><a href="AutoTrim.htm">AutoTrim</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</a>, <a href="../misc/Arrays.htm">Arrays</a></p>
    36. 

  36. <h3>Example</h3>
    37. 

  37. <pre class="NoIndent">Var1 = This is a string.
    38. 

  38. Color2 = 450
    39. 

  39. Color3 = %Var1%
    40. 

  40. Array%i% = %A_TICKCOUNT%</pre>
    41. 

  41. 

  42. </body>
    43. 

  43. </html>
    44.