setpassword

2024/03/06 15:26 Macro::TTL コマンドリファレンス
【Tera Term マクロ言語】コマンドリファレンス

setpassword 機能

[パスワードコマンド]

パスワードを追加もしくは更新します。

コマンドライン

setpassword <file name> <password name> <strvar>

機能説明

パスワードファイル <file name> のパスワード識別子 <password name> で指定されるパスワードを、入力された <strvar> に更新します。

パスワードファイルへの書き込みに失敗した場合、システム変数 <result> に 0 が格納されます。
それ以外の場合、<result> に 1 が格納されます。
<file name>
パスワードファイルを指定します。
文字列変数 <strvar> に指定されたパスワードが暗号化されて保存されます。

もし指定されたファイルが存在しなければ、新しくファイルを作成します。
<password name>
パスワードファイル内のパスワード識別子を指定します。

一つのパスワードファイルに複数のパスワードを保存することができます。
<strvar>
パスワード識別子を指定します。
各パスワードはパスワード識別子によって識別されます。

パラメータの説明

指定するパラメータは以下の通りです。
パラメータ型パラメータ説明
<file name>文字列パスワードファイルを指定します。
<password name>文字列パスワード識別子を指定します。
<strvar>文字列パスワードを格納する変数を指定します。

対象バージョン

バージョン 4.75 以降で利用可能です。

戻り値

戻り値として以下の変数が定義されます。
変数名値意味
result0パスワードファイルへの書き込みに失敗した
1パスワードファイルへの書き込みに成功した
<strvar>文字列入力した文字列
<strvar> は、コマンド実行時に指定した任意の文字列です。

関連コマンド

種別：パスワードコマンドVer機能の簡易説明
delpasswordパスワードを削除する。
getpasswordパスワードを読み出す。
ispassword4.75以降パスワードが設定されているかを判別する。
passwordboxパスワードを入力するためのダイアログボックスを開く。
4.54以降特殊文字の解釈を制御するオプションの追加。

使用方法

使用例

・パスワードを更新する場合（Ver 4.105 以前）
newpasswd = 'hoge'
setpassword 'password.dat' 'User' newpasswd
if result then
  messagebox 'Password updated successfully.' 'Result'
endif
・パスワードを更新する場合（Ver 5.0 以降）
以下の記述でも可能。
setpassword 'password.dat' 'User' 'hoge'
if result then
  messagebox 'Password updated successfully.' 'Result'
endif

サンプル

サンプルマクロはありません。

備考

バージョンバグ情報備考
対象Fix
-5.0マクロコマンドで、パスワードを文字列で渡すと Syntax Error になる問題を修正した文字列変数で渡さないと受け付けなかった