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;]
</pre>

<h2>Parameters</h2>

<dl>
        <dt class="macro">string &lt;message&gt;</dt>
        <dd>It is displayed in the dialog box.</dd>

        <dt class="macro">string &lt;title&gt;</dt>
        <dd>It is displayed as the dialog box title.</dd>

        <dt class="macro">integer &lt;special&gt; (optional default=0)</dt>
        <dd>If it is non-zero, following strings in &lt;message&gt; is treated as spacial character.<br>
            <table border="2">
             <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>
            <b><u>This option is obsolete. You are recommended to use the strspecial command.</u></b>
        </dd>
</dl>

<h2>Return Value</h2>

<dl>
        <dt class="macro">System variable &lt;inputstr&gt;</dt>
        <dd>The string entered by the user is returned.</dd>
</dl>

<h2>Remarks</h2>

<p>
The password typed by the user is not displayed as is. Instead, asterisks are displayed.
</p>

<h2>Example</h2>

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

<h2>See also</h2>
<ul>
  <li><a href="inputbox.html">inputbox</a></li>
  <li><a href="listbox.html">listbox</a></li>
  <li><a href="setdlgpos.html">setdlgpos</a></li>
  <li><a href="strspecial.html">strspecial</a></li>
  <li><a href="yesnobox.html">yesnobox</a></li>
</ul>

</body>
</html>