macro/command/passwordbox.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>passwordbox</title>
  <meta http-equiv="Content-Style-Type" content="text/css">
  <link rel="stylesheet" href="../../style.css" type="text/css">
</head>

<body>


<h1>passwordbox</h1>

<p>
Displays a dialog box prompting the user to input a password.
</p>

<pre class="macro-syntax">
passwordbox &lt;message&gt; &lt;title&gt; [&lt;special&gt;(optional)]
</pre>

<h2>Remarks</h2>

<p>
The &lt;message&gt; is displayed in the dialog box. The &lt;title&gt; is displayed as the dialog box title.
</p>

<p>
The password typed by the user is not displayed as is.<br>
Instead, asterisks are displayed. The password is returned in the system variable "inputstr".
</p>

<p>
If &lt;special&gt; is non-zero, following strings in &lt;message&gt; is treated as spacial character.<br>
If &lt;special&gt; is not specified then 1 is used.
</p>

<table>
 <tr>
  <th>input</th>
  <th>output</th>
 </tr>
 <tr>
  <td>\\</td>
  <td>"\"</td>
 </tr>
 <tr>
  <td>\n</td>
  <td>line feed</td>
 </tr>
 <tr>
  <td>\t</td>
  <td>tab</td>
 </tr>
</table>

<h2>Example</h2>

<pre class="macro-example">
<code>passwordbox 'Enter password' 'Login'
</code></pre>

</body>
</html>