macro/command/getpassword.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <title>getpassword</title>
  <meta http-equiv="Content-Style-Type" content="text/css">
  <link rel="stylesheet" href="../../style.css" type="text/css">
</head>

<body>


<h1>getpassword</h1>

<p>
Reads a password.
</p>

<h2>Format</h2>

<pre class="macro-syntax">
getpassword &lt;filename&gt; &lt;password name&gt; &lt;strvar&gt;
</pre>

<h2>Remarks</h2>

<p>
Retrieves an encrypted password identified by &lt;password name&gt; from the password file &lt;filename&gt;.<br>
Decrypts the password and stores it into the string variable &lt;strvar&gt;.
</p>

<p>
If the specified file does not exist, it is newly created.<br>
If the specified password is not stored in the file, the password dialog box appears and the entered password is stored in &lt;strvar&gt;.<br>
At the same time, the new password is encrypted and written in the file with the identifier &lt;password name&gt;.
</p>

<p>
A password file can contain multiple passwords.<br>
Each of them is identified by the password identifier.
</p>

<p>
<em>(version 4.71 or later)</em><br>
When the password file can not be written, the system variable "result" is set to 0. Otherwise, "result" is set to 1.
</p>

<h2>Example</h2>

<pre class="macro-example">
<strong>getpassword</strong> 'password.dat' 'mypassword' password
connect 'myhost'
wait 'login:'
sendln 'myname'
wait 'password:'
sendln password
</pre>

<pre class="macro-example">
expandenv str &quot;%USERPROFILE%\myfile.dat&quot;
<strong>getpassword</strong> str 'mypassword' password
if !result then
        messagebox 'Password was not saved' 'ERROR'
endif
</pre>

<h2>See also</h2>
<ul>
  <li><a href="expandenv.html">expandenv</a></li>
</ul>

</BODY>
</HTML>