31.3.4 関数

使用できる関数の一覧を示します。これらの中には、パラメータが必要であったり、パラメータが省略されたときのデフォルト動作を持った関数が含まれます。

関数名	機能
Activate	アクティブセッションの設定
Add	数値の加算
AddEscape	エスケープ文字の付加
And	論理積
AppendArray	配列の追加 (*1)
Att	文字列の連結
Bye	エミュレータの終了
ClearArray	配列内容のクリア (*1)
CmpText	文字列の比較
CopyField	クリップボード、または内部バッファへの複写（フィールド）
CopyLn	クリップボード、または内部バッファへの複写（行範囲）
CopyRc	クリップボード、または内部バッファへの複写（矩形範囲）
CopyScreen	クリップボード、または内部バッファへの複写（全画面）
CrtBoolean	論理値型変数・配列の作成 (*2)
CrtInt	整数型変数・配列の作成 (*2)
CrtString	文字列型変数・配列の作成 (*2)
Dialog	ダイアログの表示
Div	数値の除算
EnableKeyboard	マクロ実行時のキーボード／マウス入力の設定
EndDialog	ダイアログの終了
Exec	コマンドの実行
Exit	マクロの実行中止
Equ	比較
GetEnvironmentVariable	環境変数値の取得
GetError	エラー番号の取り出し
GetLength	文字列、または配列の長さ取得 (*2)
GetList	画面から一次元配列の取得 (*1)
GetPrivateValue	スクリプト変数の取得 (*1)
GetResult	結果コードの取り出し
GetString	画面文字列の取得
GetTable	画面から二次元配列の取得 (*1)
InputBox	入力メッセージボックスの表示
IsKeyboardLock	キーボードロック状態の確認
IsProtectPos	入力禁止位置の確認
IsFieldTopPos	フィールド先頭位置の確認
IsFieldEndPos	フィールド最終位置の確認
IsNumField	数字フィールドの確認
Large	大なり比較
MsgBox	メッセージボックスの表示
Mul	数値の乗算
Not	論理反転
Or	論理和
Paste	クリップボード、または内部バッファからの貼り付け
PutValue	変数・配列へ値を代入 (*2)
Scan	文字列検索
SetCursorPos	カーソル位置の設定
SetKeyUnlockTime	キーアンロック時間の設定 (*2)
SetPrivateValue	スクリプト変数値の設定 (*1)
SetWaitTime	最大待ち時間の設定
Sleep	指定時間実行を停止
Small	小なり比較
Start	セッションの起動
Stop	セッションの終了
Sub	数値の減算
Sur	数値除算の剰余を取得
ToInt	数字文字列の数値変換
ToString	数値の文字列変換
Type	キーの入力
TypeKey	キーの1文字即時入力
Wait	ホストからの文字列待ち合わせ

*1：HTMLモードでのみ利用可能な関数
*2：HTMLモードでのみ利用可能な指定のある関数

パラメータを省略する時は、後ろのパラメータから順番に省略できます。途中のパラメータを省略することはできません。

例）  Type("ABC", 20, 10) ;省略なし
      Type("ABC")         ;行と桁を省略

■Activate

アクティブセッションの設定（LU切り替え）

アクティブセッションをディスプレイセッション１～４、またはプリンタセッションのいずれかに切り替えます。すでにアクティブの場合は、正常終了します。

●呼び出し形式

Activate(PathName)

●パラメータ

パラメータ	説明	省略時の初期値
PathName	接続パス名 (DSP1,DSP2,DSP3,DSP4,PRN)	省略できません

●リターン値

関数の呼び出しに成功するとTRUEを返します。エラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

Activate("DSP1")  ; ディスプレイセッション1に切り替えます。

■Add

整数の加算

パラメータで指定された2つの整数値を加算します。

●呼び出し形式

Add(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	整数	省略できません
Val2	整数	省略できません

●リターン値

関数の呼び出しに成功すると演算結果の数値を返します。エラーが発生した場合は-1を返します。リターン値が-1の場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

CrtInt(Val1, 10)                ;変数「Val1」を定義し、値に10を代入します。
CrtInt(Result)                  ;変数「Result」を定義します。
PutValue(Result, Add(Val1, 10)) ;変数「Result」には演算結果の20が格納されます。

■AddEscape

エスケープ文字の付加

パラメータで指定した文字列へ必要に応じてエスケープ文字を付加します。文字列を扱うマクロ関数（InputBox、Att、GetString）から返却された文字列にはエスケープ文字が付加されない場合があるため、他のマクロ関数（Type、Wait、MsgBox、InputBox、Equ、CmpText、Scan）で使用時に構文エラー（ERROR_SYNTAX）となることがあります。この場合、本関数でエスケープ文字を付加することができます。

●呼び出し形式

AddEscape(String)

●パラメータ

パラメータ	説明	省略時の初期値
String	文字列	省略できません

●リターン値

関数の呼び出しに成功すると必要に応じてエスケープ文字が付加された文字列を返します。パラメータに空文字列を指定した場合、およびエラーが発生した場合は空文字列を返します。リターン値が空文字列の場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

CrtString(Val1)                        ;「Val1」という文字列変数を定義します。
PutValue(Val1, GetString(1, 1, 1, 10)) ; 変数「Val1」へ文字列を取得します。
AddEscape(Val1)                        ; 変数「Val1」の文字列にエスケープ文字を付加します。

■And

論理積

パラメータで指定された2つの数値を論理積（AND）演算します。

●呼び出し形式

And(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	論理値、整数値	省略できません
Val2	論理値、整数値	省略できません

●リターン値

関数の呼び出しに成功すると演算結果(TRUE、またはFALSE)を返します。パラメータに整数値が指定された場合、0をFALSE、0以外をTRUEとして返します。演算結果がFALSEの場合、またはエラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。演算結果がFALSEの場合はGetError関数では0（正常）が返ります。

●使用例

CrtBoolean(Val1, FALSE)       ;「Val1」という論理型変数を定義します。
CrtBoolean (Val2, FALSE)      ;「Val2」という論理型変数を定義します。
PutValue(Val1, Large(20, 30)) ;「20 > 30」の結果を「Val1」に代入します。
PutValue(Val2, Small(5, 10))  ;「5 < 10」の結果を「Val2」に代入します。
And(Val1, Val2)               ; 変数「Val1」と「Val2」の論理積を求めて、FALSEと返却します。

■AppendArray

配列の追加

第一パラメータに指定した配列の末尾に、第二パラメータで指定した配列を追加します。各パラメータに指定する配列が二次元配列の場合は、配列を構成する列の要素数が同一である必要があります。
二次元配列に一次元配列を追加した場合は、二次元配列の一次元目の末尾(行要素)に指定した配列が追加されます。本関数はHTMLモードでのみ利用可能です。

●呼び出し形式

AppendArray(Array1, Array2)

●パラメータ

パラメータ	説明	省略時の初期値
Array1	配列	省略できません
Array2	配列	省略できません

●リターン値

●使用例

CrtString(Array1[][])        ;「Array1」という文字列二次元配列を定義します。
CrtString(Array2[][])        ;「Array2」という文字列二次元配列を定義します。
PutValue(Array1, GetTable()) ; 画面からテーブルを取得して、「Array1」に保存します。
Type("[ENTER]")              ; ENTERをホストに送信して、画面を更新します。
PutValue(Array2, GetTable()) ; 画面からテーブルを取得して、「Array2」に保存します。
AppendArray (Array1, Array2) ;「 Array2」を「Array1」の後ろにつけます。

■Att

文字列の連結

第一パラメータで指定した文字列と第二パラメータで指定した文字列を連結します。

●呼び出し形式

Att(String1, String2)

●パラメータ

パラメータ	説明	省略時の初期値
String1	文字列	省略できません
String2	文字列	省略できません

●リターン値

関数の呼び出しに成功すると連結後の文字列を返します。両方のパラメータに空文字列を指定した場合、およびエラーが発生した場合は空文字列を返します。リターン値が空文字列の場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

CrtString(Val1, "ABC")           ;「Val1」という文字列変数を定義します。
PutValue(Val1, Att(Val1, "DEF")) ; 変数「Val1」に"DEF"を連結して、"ABCDEF"と返却します。

■Bye

エミュレータの終了

エミュレータを終了します。接続アイコンの表示スタイルが「ブラウザの中でエミュレータを表示する」の場合は、表示ページを1つ戻すことによりエミュレータを終了します。（「戻る」ボタンを押すのと同等）
セッションが起動されている場合は、すべてのセッションを強制終了してからブラウザを終了します。
セッションが起動している場合、プロパティの設定に従って警告ダイアログを表示します。警告ダイアログでキャンセルした場合は、セッションの終了は中断され終了は行いません。
接続アイコンの表示スタイルが「ブラウザの中でエミュレータを表示する」の場合、戻り先のページがない場合はブラウザを終了します。ただし、HTMLのフレームを使用している場合、エミュレータを表示した後でページ移動が発生するとByeメソッドを実行しても移動する前のページに戻るためエミュレータを終了できません。この場合、window.openメソッドを使用してエミュレータが表示されているフレームのページを他のページに切り替えることでエミュレータを終了させることができます。

●呼び出し形式

Bye(ResultCode)

●パラメータ

パラメータ	説明	省略時の初期値
ResultCode	意味をもちません	省略できません

●使用例

Bye(0)

■ClearArray

配列内容のクリア

指定された配列の内容をクリアします。本関数はHTMLモードでのみ利用可能です。

●呼び出し形式

ClearArray(Array)

●パラメータ

パラメータ	説明	省略時の初期値
Array	配列	省略できません

●リターン値

●使用例

CrtString(Array1[][])         ;「Array1」という文字列二次元配列を定義します。
PutValue(Array1, GetTable())  ; 画面からテーブルを取得して、「Array1」に保存します。
ClearArray(Array1)            ;「Array1」の内容をクリアします。

■CmpText

文字列の比較

ホスト画面受信バッファの指定位置と指定文字列を比較します。比較結果はリターン値で確認できます。

●呼び出し形式

CmpText(Text, Row, Col)

●パラメータ

パラメータ	説明	省略時の初期値
Text	比較する文字列	省略できません
Row	比較開始行位置（1～24）	カーソル位置
Col	比較開始桁位置（1～80）	カーソル位置

●リターン値

文字列が一致した場合はTRUEを返します。文字列が一致しなかった場合やエラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

IF( CmpText("A") )
      MsgBox("現在カーソルは A の上にあります")
ELSE
      MsgBox("現在カーソルは A 以外の上にあります")
ENDIF

■CopyField

クリップボード、または内部バッファへの複写（フィールド）

指定位置のフィールド内範囲を、HTMLモードの場合は内部バッファ、ActiveXモードの場合はクリップボードへ複写します。内部バッファ、およびクリップボードには、CF_TEXT形式のデータが置かれます。

●呼び出し形式

CopyField(Row, Col)

●パラメータ

パラメータ	説明	省略時の初期値
Row	複写フィールド行位置（1～24）	カーソル位置
Col	複写フィールド桁位置（1～80）	カーソル位置

●リターン値

■CopyLn

クリップボード、または内部バッファへの複写（行範囲）

指定位置で囲まれる行範囲を、HTMLモードの場合は内部バッファ、ActiveXモードの場合はクリップボードへ複写します。内部バッファ、およびクリップボードには、CF_TEXT形式のデータが置かれます。

●呼び出し形式

CopyLn(Row1, Col1, Row2, Col2)

●パラメータ

パラメータ	説明	省略時の初期値
Row1	複写範囲開始行位置（1～24）	1
Col1	複写範囲開始桁位置（1～80）	1
Row2	複写範囲終了行位置（1～24）	24
Col2	複写範囲終了桁位置（1～80）	80

●リターン値

■CopyRc

クリップボード、または内部バッファへの複写（矩形範囲）

指定位置で囲まれる矩形範囲を、HTMLモードの場合は内部バッファ、ActiveXモードの場合はクリップボードへ複写します。内部バッファ、およびクリップボードには、CF_TEXT、CF_BITMAP、CF_METAFILEPICT形式のデータが置かれます。

●呼び出し形式

CopyRc(Row1, Col1, Row2, Col2)

●パラメータ

パラメータ	説明	省略時の初期値
Row1	複写範囲開始行位置（1～24）	1
Col1	複写範囲開始桁位置（1～80）	1
Row2	複写範囲終了行位置（1～24）	24
Col2	複写範囲終了桁位置（1～80）	80

●リターン値

■CopyScreen

クリップボード、または内部バッファへの複写（全画面）

全画面範囲を、HTMLモードの場合は内部バッファ、ActiveXモードの場合はクリップボードへ複写します。内部バッファ、およびクリップボードには、CF_TEXT形式のデータが置かれます。

●呼び出し形式

CopyScreen()

●パラメータ

ありません

●リターン値

■CrtBoolean

論理値型変数・配列の作成

論理値型の変数または配列を新しく定義します。定義する変数を指定値で初期化することも可能です。

配列の定義はHTMLモードでのみ利用可能です。

●呼び出し形式

CrtBoolean(Val, Initval)
CrtBoolean(Array[])
CrtBoolean(Array[][])

●パラメータ

パラメータ	説明	省略時の初期値
Val	作成する変数または配列名	省略できません
Array	作成する配列名	省略できません
Initval	変数を初期化する論理値(TRUE、またはFALSE) 、または整数	FALSE

●リターン値

●使用例

CrtBoolean(Val, TRUE)  ; 変数「Val」をTRUEで初期化して定義します。
CrtBoolean(Array1[][]) ; 二次元配列型の変数「Array1」を定義します。

■CrtInt

整数型変数・配列の作成

整数型の変数または配列を新しく定義します。定義する変数を指定値で初期化することも可能です。

配列の定義はHTMLモードでのみ利用可能です。

●呼び出し形式

CrtInt(Val, Initval)
CrtInt(Array[])
CrtInt(Array[][])

●パラメータ

パラメータ	説明	省略時の初期値
Val	作成する変数または配列名	省略できません
Array	作成する配列名	省略できません
Initval	変数を初期化する10進数の整数値 (-2147483648～2147483647)	0

●リターン値

●使用例

CrtInt(Val, 65535) ; 変数「Val」を65535で初期値して定義します。
CrtInt(Array[][])  ; 二次元配列型の変数「Array」を0で初期化して定義します。

■CrtString

文字列型変数・配列の作成

文字列型の変数または配列を新しく定義します。定義する変数を指定値で初期化することも可能です。
指定する初期値の文字列は(")ダブルコートで囲む必要があります。

配列の定義はHTMLモードでのみ利用可能です。

●呼び出し形式

CrtString(Val, Initval)
CrtString(Array[])
CrtString(Array[][])

●パラメータ

パラメータ	説明	省略時の初期値
Val	作成する変数または配列名	省略できません
Array	作成する配列名	省略できません
Initval	変数を初期化する文字列 (指定可能な最大文字数は半角換算で4096文字まで)	"" (空文字列)

●リターン値

●使用例

CrtString(Val, "VALUE")  ; 変数「Val」を"VALUE"で初期化して定義します。
CrtString(Array[][])     ; 二次元配列型の変数「Array」を""で初期化して定義します。

■Dialog

ダイアログの表示

ダイアログテンプレートに従ってダイアログを表示します。ダイアログが終了するまでこの関数は制御を戻しません。ダイアログを終了するには【メニュー】+【F4】キーを押すか、EndDialog関数を呼び出すことによって終了します。

●呼び出し形式

Dialog(Template)

●パラメータ

パラメータ	説明	省略時の初期値
Template	ダイアログテンプレート名	省略できません

●リターン値

関数の呼び出しに成功するとTRUEを返します。エラーが発生した場合はFALSEを返します。リターン値がTRUEの場合はGetResult関数を使ってダイアログ処理結果を調べることができます。【メニュー】+【F4】キーを押して終了した場合、ダイアログ処理結果は0になります。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。

■Div

数値の除算

第一パラメータで指定した数値を第二パラメータで指定した数値で除算します。演算結果が整数にならない場合は小数点以下を切り捨てた整数値を返します。

●呼び出し形式

Div(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	除算される整数値	省略できません
Val2	除算する整数値	省略できません

●リターン値

関数の呼び出しに成功すると演算結果を返します。リターン値が-1の場合はGetError関数を使ってエラー番号を調べることができます。
演算の結果として-1が返る場合もあります。この場合はGetError関数では0（正常）が返ります。

●使用例

CrtInt(Val1, 10)              ; 変数「Val1」を定義(初期値に10を代入)します。
PutValue(Val1, Div(Val1, 10)) ; 変数「Val1」の値を10で除算して1を返却します。

■EnableKeyboard

マクロ実行時のキーボード／マウス入力の設定

マクロ実行時にディスプレイエミュレータへのキーボードやマウスによる入力を許可、または禁止します。本関数を使用しない場合のマクロ実行時の入力は禁止です。

マクロ実行時の入力を許可した場合、マクロ実行中の【Esc】キーの入力はマクロ実行中止の動作ではなく、エミュレータキーに割り当てられたキー（標準で割り当てられるキーはRESETキー）として動作します。また、マクロ実行キーは入力しても無視されます。
本マクロはActiveXモードの利用時のみ使用できます。

●呼び出し形式

EnableKeyboard(Val)

●パラメータ

パラメータ	説明	省略時のデフォルト値
Val	入力許可時の指定（TRUE）	省略できません
Val	入力禁止時の指定（FALSE）	省略できません

●リターン値

ありません

■EndDialog

ダイアログの終了

表示中のダイアログを終了させます。パラメータを1つ持ちダイアログの処理結果を表します。この値はダイアログを終了後にGetResult関数を使って調べることができます。

●呼び出し形式

EndDialog(ResultCode)

●パラメータ

パラメータ	説明	省略時の初期値
ResultCode	処理結果コード	0

●リターン値

■Exec

子プロセスの起動

プログラムを呼び出します。呼び出したプログラムの終了を待たずにこの関数は制御を戻します。プログラムの起動結果はGetResult関数で調べることができます。
本マクロはActiveXモードの利用時のみ使用できます。

●呼び出し形式

Exec(CmdLine)

●パラメータ

パラメータ	説明	省略時の初期値
CmdLine	コマンドライン	省略できません

●リターン値

●使用例

Exec("CMD /c copy import.txt a:")

■Exit

マクロの実行中止

実行中のマクロを中止します。

●呼び出し形式

Exit()

●パラメータ

ありません

●リターン値

■Equ

比較

2つのパラメータの値を比較します。比較するパラメータに異なる型は指定できません。配列の比較は配列数と要素の両方を比較します。

●呼び出し形式

Equ(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	比較する第1パラメータ (整数、文字列、論理値、配列)	省略できません
Val2	比較する第2パラメータ (整数、文字列、論理値、配列)	省略できません

●リターン値

2つのパラメータの値が等しい場合はTRUEを返します。値が等しくない場合、またはエラーの場合や型が一致していない場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。比較結果が等しくない場合はGetError関数では0（正常）が返ります。

●使用例

キー入力でキー入力禁止エラーだった場合に、リセットキーで入力禁止状態を解除しています。

Type("ABC")

IF( Equ(GetError(), ERROR_DNYKEY) )
      Type("[RESET]")
ENDIF

■GetEnvironmentVariable

環境変数値の取得

OSに登録された環境変数、またはWSMGR for Webの環境変数を取得します。

OSの環境変数は使用するWindowsアカウントの権限によって参照できる値が異なる場合があります。

●呼び出し形式

GetEnvironmentVariable(Name)

●パラメータ

パラメータ	説明	省略時の初期値
Name	環境変数名	省略できません

●リターン値

関数の呼び出しに成功すると、指定された環境変数名で取得した文字列を返します。環境変数名が存在しない場合、またはエラーが発生した場合は空文字列を返します。リターン値が空文字列の場合はGetError関数を使ってエラー番号を調べることができます。環境変数名が存在しない場合はGetError関数では0（正常）が返ります。

●使用例

GetEnvironmentVariable("WSMGR_USERNAME")

■GetError

エラー番号の取得

関数がエラー終了したときのエラー番号を取得します。エラーが発生していない場合はERROR_NONEを返します。

●呼び出し形式

GetError()

●パラメータ

ありません

●リターン値

エラーが発生していない場合はERROR_NONEを、エラーが発生している場合はそのエラー番号を返します。ERROR_NONEは 0 です。

値	意味
ERROR_NONE	エラーはありません。
ERROR_NOMEMORY	メモリ不足が発生しました。
ERROR_NOTCNCT	ホストと接続されていません。
ERROR_TIMEOUT	タイムアウトが発生しました。
ERROR_DNYKEY	キー入力禁止でした。
ERROR_NOSCAN	文字列が見つかりませんでした。
ERROR_INVPARAM	パラメータが不正です。
ERROR_INVKEY	Type関数で無効なキーが指定されました。
ERROR_ABORT	セッションが異常終了しました。
ERROR_INVPATHNAME	接続パス名が不正です。
ERROR_FILENOTEXIST	Exec関数で指定されたプログラムが見つかりません。
ERROR_NOEXEC	Exec関数で指定されたプログラムが実行できませんでした。
ERROR_CANTSTART	Start関数でセッションが起動できませんでした。
ERROR_CANTSTOP	Stop関数でセッションが終了できませんでした。
ERROR_NOTSTART	セッションが未起動です。
ERROR_NOSUPPORT	未サポート関数が呼び出されました。
ERROR_SYNTAX	パラメータに構文エラーがあります。
ERROR_PARAMTYPE	パラメータが論理値と整数ではありません。
ERROR_OVERFLOW	演算結果が整数の範囲を超えます。
ERROR_LENGTH	文字列は4096半角文字、または2048全角文字を超過します。
ERROR_DIV0	0で割ろうとしています。
ERROR_NODEFINE	関数所属の有効範囲に指定された変数が定義されていません。
ERROR_SCRIPT	添字は0より小さい、また要素数以上になります。
ERROR_INVALIDNAME	変数名は命名規約に違反します。
ERROR_REDEFINED	変数の定義が重複になります。
ERROR_BUFFEROVER	連結後文字列が4096半角文字、または2048全角文字を超過します。
ERROR_TOINT	使用できない文字を含む文字列をパラメータとして指定しました。
ERROR_INVPARAM	行は1～24以外、または列は1～80以外の値で指定されています。
ERROR_OPTION	入力文字の表示方法は、"INDICATE"、"PASSWORD"(、"SUSPEND")以外の値で設定されます。
ERROR_NOMATCH	二次元配列の列要素数が一致しません。
ERROR_BLOCK	制御文のスタートとエンドがマッチしていない場合発生します。
ERROR_INTERNAL	プログラムの内部処理でエラーが発生しました。
ERROR_ARRAYSIZE	配列の定義で、指定された要素数が整数ではありません、またそのサイズは正しくありません。
ERROR_NOENVIRONMENT	指定された環境変数が定義されていません。

■GetLength

文字列または配列の長さ取得

指定された文字列、または配列の長さを取得します。文字列の場合は文字数、一次元配列の場合は配列の要素数、二次元配列の場合は行要素数を返します。配列の指定はHTMLモードでのみ利用可能です。

●呼び出し形式

GetLength(Val)

●パラメータ

パラメータ	説明	省略時の初期値
Val	文字列、配列	省略できません

●リターン値

関数の呼び出しに成功すると文字列、または配列の長さを返します。エラーが発生した場合は-1を返します。リターン値が-1の場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

CrtString(Array[][])        ;「Array」という文字列型二次元配列を定義します。
PutValue(Array[9][19], "X") ; 要素Array[9][19]に"X"を設定します。
GetLength(Array)            ; Arrayのレングスを取得して、20を返却します。
GetLength(Array[2])         ; Array [2]のレングスを取得して、10を返却します。
GetLength(Array[2][3])      ; Array [2][3]のレングスを取得して、2を返却します。

■GetList

画面から一次元配列を取得

ディスプレイエミュレータ画面上の指定した範囲に含まれるフィールドの文字列を一次元配列として取得します。取得した文字列の前後にある空白（半角および全角）やタブ文字は削除されます。指定する範囲は、開始行桁のみを指定、またはすべて省略することも可能です。

本関数はHTMLモードでのみ利用可能です。

●呼び出し形式

GetList(Row1, Col1, Row2, Col2)

●パラメータ

パラメータ	説明	省略時の初期値
Row1	範囲の開始行位置(1～24)	1
Col1	範囲の開始桁位置(1～80)	1
Row2	範囲の終了行位置(1～24)	24
Col2	範囲の終了桁位置(1～80)	80

●リターン値

関数の呼び出しに成功すると一次元配列を返します。文字列がフィールドに存在しない場合、またはエラーが発生した場合は空文字列を返します。リターン値が空文字列の場合はGetError関数を使ってエラー番号を調べることができます。文字列がフィールドに存在しない場合はGetError関数では0（正常）が返ります。

●使用例

CrtString(Array1[])          ;「Array1」という文字列一次元配列を定義します。
CrtString(Array2[])          ;「Array2」という文字列一次元配列を定義します。
PutValue(Array1, GetList())  ; 画面からリストを取得して、「Array1」に保存します。
Type("[ENTER]")              ; ENTERをホストに送信して、画面を更新します。
PutValue(Array2, GetList())  ; 画面からリストを取得して、「Array2」に保存します。
AppendArray (Array1, Array2) ;「Array2」を「Array1」の後ろ追加します。

■GetPrivateValue

スクリプト変数の取得

SetPrivateValue関数でマクロに保存されたスクリプト変数を取得します。

本関数はHTMLモードでのみ利用可能です。

●呼び出し形式

GetPrivateValue(name)

●パラメータ

パラメータ	説明	省略時の初期値
name	文字列で指定されたスクリプト変数名	省略できません

●リターン値

関数の呼び出しに成功すると取得されたスクリプト変数値を返します。エラーが発生した場合は空文字を返します。リターン値が空文字の場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

SetPrivateValue("val1", 100) ;スクリプト変数「val1」に100を格納します。

GetPrivateValue("val1")      ;スクリプト変数「val1」の値を取得します。

■GetResult

結果コードの取得

EndDialogで返された値、またはExec関数によって実行されたコマンドの起動結果を取得します。

●呼び出し形式

GetResult()

●パラメータ

ありません

●リターン値

結果コードを表します。

■GetString

画面文字列の取得

ディスプレイエミュレータ画面上の指定した範囲に表示中の文字列を取得します。取得した文字列の前後にある空白（半角および全角）やタブ文字は削除されます。
指定範囲の終了行桁を省略した場合は、エミュレータ画面の最大行桁までの文字列を取得します。指定範囲をすべて省略した場合は現在のカーソル位置から、エミュレータ画面の最大行桁までの文字列を取得します。

注意

指定した位置が全角文字の前半または後半の場合、その文字は取得されません。

●呼び出し形式

GetString(Row1, Col1, Row2, Col2)

●パラメータ

パラメータ	説明	省略時の初期値
Row1	範囲の開始行位置(1～24)	1
Col1	範囲の開始桁位置(1～80)	1
Row2	範囲の終了行位置(1～24)	24
Col2	範囲の終了桁位置(1～80)	80

●リターン値

関数の呼び出しに成功すると取得した文字列を返します。文字列が存在しない場合、またはエラーが発生した場合は空文字を返します。リターン値が空文字の場合はGetError関数を使ってエラー番号を調べることができます。文字列が存在しない場合はGetError関数では0（正常）が返ります。

●使用例

CrtString(String1)                       ;「String1」という文字列変数を定義します。
PutValue(String1, GetString(1, 1, 1, 10)); 1行1桁から1行10桁に含まれる文字列を取得して、変数へ保存します。

■GetTable

画面から二次元配列の取得

ディスプレイエミュレータ画面上の指定した範囲に存在するフィールドの内容を文字列の二次元配列として取得します。取得した文字列の前後にある空白（半角および全角）やタブ文字は削除されます。

本関数はHTMLモードでのみ利用可能です。

●呼び出し形式

GetTable(Row1, Col1, Row2, Col2)

●パラメータ

パラメータ	説明	省略時の初期値
Row1	範囲の開始行位置(1～24)	1
Col1	範囲の開始桁位置(1～80)	1
Row2	範囲の終了行位置(1～24)	24
Col2	範囲の終了桁位置(1～80)	80

●リターン値

関数の呼び出しに成功すると取得した文字列を二次元配列で返します。文字列が存在しない場合、またはエラーが発生した場合は空文字を返します。リターン値が空文字の場合はGetError関数を使ってエラー番号を調べることができます。文字列が存在しない場合はGetError関数では0（正常）が返ります。

●使用例

CrtString(Array1[][])        ;「Array1」という文字列二次元配列を定義します。
CrtString(Array2[][])        ;「Array2」という文字列二次元配列を定義します。
PutValue(Array1, GetTable()) ; 画面からテーブルを取得して、「Array1」に保存します。
Type("[ENTER]")              ; ENTERをホストに送信して、画面を更新します。
PutValue(Array2, GetTable()) ; 画面からテーブルを取得して、「Array2」に保存します。
AppendArray (Array1, Array2) ;「Array2」を「Array1」の後ろに追加します。

■InputBox

入力メッセージボックスの表示

入力領域を持つメッセージボックスを表示し、マクロ実行中に入力を行うことができます。メッセージボックスの表示中はマクロの実行を一時停止します。入力領域の長さは1～100文字まで指定可能です。入力領域はパラメータで入力文字の表示方法を指定できます。"PASSWORD"を指定すると入力した文字が"*"で表示されます。"INDICATE"または何も指定しない場合は入力した文字をそのまま表示します。メッセージボックスのボタンスタイルは"OK"固定です。

●呼び出し形式

InputBox(Title, Message, InputLength, Option)

●パラメータ

パラメータ	説明	省略時の初期値
Title	メッセージボックスのタイトル文字列	省略できません
Message	メッセージボックスに表示するメッセージ文字列	省略できません
InputLength	入力領域の長さ(1～100)	省略できません
Option	入力文字の表示方法 INDICATE：文字をそのまま表示 PASSWORD："*"で表示	INDICATE

●リターン値

関数の呼び出しに成功し、入力文字があると入力された文字列を返します。文字列が存在しない場合、またはエラーが発生した場合は空文字を返します。リターン値が空文字の場合はGetError関数を使ってエラー番号を調べることができます。文字列が存在しない場合はGetError関数では0（正常）が返ります。

●使用例

InputBox("パスワード", "パスワードを入力してください", 20, "PASSWORD"); パスワード入力ボックスを表示

■IsKeyboardLock

キーボードロック状態の確認

現在キー入力禁止状態か確認します。

●呼び出し形式

IsKeyboardLock()

●パラメータ

ありません

●リターン値

関数を呼び出した時にキー入力禁止だったらTRUEを返します。キー入力可能ならばFALSEを返します。

●使用例

IF( IsKeyboardLock() )
      MsgBox("キー入力できない状態です")
ENDIF

■IsProtectPos

入力禁止位置の確認

指定位置がキー入力禁止位置か確認します。

●呼び出し形式

IsProtectPos(Row, Col)

●パラメータ

パラメータ	説明	省略時の初期値
Row	確認行位置（1～24）	カーソル位置
Col	確認桁位置（1～80）	カーソル位置

●リターン値

関数を呼び出した時に指定位置がキー入力禁止位置だったらTRUEを返します。キー入力可能位置ならばFALSEを返します。

●使用例

IF( IsProtectPos(2, 10) )
      MsgBox("2 行 10桁目は、 キー入力禁止位置です")
ENDIF

■IsFieldTopPos

フィールド先頭位置の確認

指定位置がフィールドの先頭位置か確認します。

●呼び出し形式

IsFieldTopPos(Row, Col)

●パラメータ

パラメータ	説明	省略時の初期値
Row	確認行位置（1～24）	カーソル位置
Col	確認桁位置（1～80）	カーソル位置

●リターン値

関数を呼び出した時に指定位置がフィールドの先頭位置だったらTRUEを返します。

それ以外の位置、またはアトリビュート文字位置ならばFALSEを返します。

不定様式画面のときは、1行1桁目がフィールドの先頭位置として扱われます。

●使用例

IF( Not( IsFieldTopPos() ) )
      TypeKey("[BACKTAB]")    ; フィールドの先頭へカーソルを移動
ENDIF

■IsFieldEndPos

フィールド最終位置の確認

指定位置がフィールドの最終位置か確認します。

●呼び出し形式

IsFieldEndPos(Row, Col)

●パラメータ

パラメータ	説明	省略時の初期値
Row	確認行位置（1～24）	カーソル位置
Col	確認桁位置（1～80）	カーソル位置

●リターン値

関数を呼び出した時に指定位置がフィールドの最終位置だったらTRUEを返します。
それ以外の位置、またはアトリビュート文字位置ならばFALSEを返します。
不定様式画面のときは、24行80桁目がフィールドの最終位置として扱われます。

■IsNumField

数字フィールドの確認

指定位置のフィールドが数字フィールドか確認します。

●呼び出し形式

IsNumField(Row, Col)

●パラメータ

パラメータ	説明	省略時の初期値
Row	確認行位置（1～24）	カーソル位置
Col	確認桁位置（1～80）	カーソル位置

●リターン値

関数を呼び出した時に指定位置のフィールドが数字フィールドだったらTRUEを返します。それ以外ならばFALSEを返します。

■Large

大なり比較

第一パラメータで指定した値が第二パラメータで指定した値より大きいかを比較します。比較するパラメータに異なる型は指定できません。

●呼び出し形式

Large(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	整数、または文字列	省略できません
Val2	整数、または文字列	省略できません

●リターン値

関数の呼び出しに成功し、第一パラメータの値が第二パラメータの値より大きい場合はTRUEを返します。第一パラメータの値が第二パラメータの値より小さい場合や等しい場合、およびエラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。第一パラメータの値が第二パラメータの値より小さい場合や等しい場合はGetError関数では0（正常）が返ります。

●使用例

CrtInt(Val1, 20) ; 変数「Val1」を定義(初期値に20を代入)します。
Large(Val1, 10)  ; 変数「Val1」の値と10を比較しTRUEを返却します。

■MsgBox

メッセージボックスの表示

指定されたメッセージを表示しボタンが押されるまでポーズします。表示されるボタンはスタイルによって指定できます。

●呼び出し形式

MsgBox(Text, Style)

●パラメータ

パラメータ	説明	省略時の初期値
Text	表示する文字列	省略できません
Style	OK、OKCANCEL、YESNOのいずれかを指定します。	OKスタイルを持ちます

●リターン値

スタイルと押されたボタンによって次の値が返されます。

スタイル	押されたボタン	リターン値
OK	［OK］	TRUE
OKCANCEL	［OK］	TRUE
OKCANCEL	［キャンセル］	FALSE
YESNO	［はい］	TRUE
YESNO	［いいえ］	FALSE

●使用例

MsgBox("メッセージを表示します")
MsgBox("選択してください", YESNO)

■Mul

数値の乗算

パラメータで指定した2つの整数値を乗算します。

●呼び出し形式

Mul(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	整数	省略できません
Val2	整数	省略できません

●リターン値

関数の呼び出しに成功すると演算結果を返します。エラーが発生した場合は-1を返します。リターン値が-1の場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

CrtInt(Val1, 20)                ; 変数「Val1」を定義(初期値に20を代入)します。
PutValue(Val1, Mul(Val1, 10))   ; 乗算した結果200を返却します。

■Not

論理反転

パラメータの値を論理反転します。TRUE（真）はFALSE（偽）に、FALSEはTRUEになります。

●呼び出し形式

Not(Val)

●パラメータ

パラメータ	説明	省略時の初期値
Val	論理値、整数値論理値または整数を返却する関数も指定可能	省略できません

●リターン値

反転結果を返します。パラメータに整数値が指定された場合、0をTRUE、0以外をFALSEとして返します。演算結果がFALSEの場合、またはエラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。演算結果がFALSEの場合はGetError関数では0（正常）が返ります。

●使用例

IF( Not( 0 ) )
      MsgBox("0 の反転は TRUE です。")
ENDIF

■Or

論理和

パラメータで指定した2つの値を論理和（OR）演算します。

●呼び出し形式

Or(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	論理値、整数	省略できません
Val2	論理値、整数	省略できません

●リターン値

●使用例

CrtBoolean(Val1, FALSE)       ;「Val1」という論理型変数を定義します。
CrtBoolean(Val2, FALSE)       ;「Val2」という論理型変数を定義します。
PutValue(Val1, Large(20, 30)) ;「20 > 30」の結果を「Val1」に代入します。
PutValue(Val2, Small(5, 10))  ;「5 < 10」の結果を「Val2」に代入します。
Or(Val1, Val2)                ; 変数「Val1」と「Val2」の論理和を求めて、TRUEと返却します。

■Paste

クリップボード、または内部バッファからの貼り付け

クリップボード、またはエミュレータの内部バッファの内容を現在のカーソル位置へ貼り付けます。キー入力禁止状態のときはエラー復帰します。
HTMLモードの場合、複写したデータの貼り付けが行えるのは、HTMLモードのエミュレータ間のみです。

●呼び出し形式

Paste()

●パラメータ

ありません

●リターン値

●使用例

;;
;; 現在のフィールドにあるデータを次のフィールドに複写します
;;
CopyField()
TypeKey("[TAB]")
TypeKey("[ERASEEOF]")
Paste()

■PutValue

変数・配列へ値を代入

定義済みの変数への値の代入、配列から配列への値コピーが可能です。配列間のコピーはHTMLモードでのみ利用可能です。

注意

未定義の変数または配列は指定できません。
代入する値と代入先の変数の型は一致している必要があります。
配列間のコピーではコピー先の要素を上書きします。

●呼び出し形式

PutValue(Val1, Value)
PutValue(Array1[Index], Value)
PutValue(Array1[Index1][Index2], Value)
PutValue(Array1, Array2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	代入先の変数名	省略できません※
Index	変数が一次元配列の場合の代入先のインデックス値(0以上の整数)	省略できません※
Index1	変数が二次元元配列の場合の代入先の行インデックス値(0以上の整数)	省略できません※
Index2	変数が二次元元配列の場合の代入先の列インデックス値(0以上の整数)	省略できません※
Value	変数への代入値(整数、文字列、論理値) 変数と同型を返却する関数も指定可能	省略できません※
Array1	コピー先の配列	省略できません※
Array2	コピー元の配列	省略できません※

※パラメータの組み合わせにより必要なパラメータが決まります。

●リターン値

●使用例

CrtInt(Val, 10)                   ;「Val」という整数型変数を定義して、10で初期化します。
PutValue(Val, 20)                 ; 変数「Val」に20を代入します。
CrtString(Array1[])               ;「Array1」という文字列型一次元配列を定義します。
PutValue(Array1[10], "STRING")    ;「Array1[10]」に文字列"STRING"を代入します。
CrtString(Array2[][])             ;「Array2」という文字列型二次元配列を定義します。
PutValue(Array2[10][10], "STR")   ;「Array2[10][10]」に"STR"を代入します。
CrtString(Array3[][])             ;「Array3」という文字列型二次元配列を定義します。
PutValue(Array3, Array2)          ;「Array3」を「Array2」で上書きします。

■Scan

文字列検索

ホスト画面受信バッファに指定文字列が存在するかを調べます。検索結果はリターン値で確認できます。

●呼び出し形式

Scan(Text, Row1, Col1, Row2, Col2)

●パラメータ

パラメータ	説明	省略時の初期値
Text	検索する文字列	省略できません
Row1	検索開始行位置（1～24）	1
Col1	検索開始桁位置（1～80）	1
Row2	検索終了行位置（1～24）	24
Col2	検索終了桁位置（1～80）	80

●リターン値

文字列が見つかった場合はTRUEを返します。文字列が見つからなかった場合やエラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。文字列が見つからなかった場合はGetError関数では0（正常）が返ります。

●使用例

IF( Scan("TSSX") )
      MsgBox("ログオンが完了しました")
ELSE
      MsgBox("ログオンは完了していません")
ENDIF

■SetCursorPos

カーソル位置の設定

カーソル位置を指定位置へ移動します。キー入力禁止状態のときはエラー復帰します。

●呼び出し形式

SetCursorPos(Row, Col)

●パラメータ

パラメータ	説明	省略時の初期値
Row	カーソル行（1～24）	省略できません
Col	カーソル桁（1～80）	省略できません

●リターン値

■SetKeyUnlockTime

キーアンロックタイムの設定

キーアンロックタイムは、キーボードロック中に一瞬ロックが解除されることがあるため、この解除を本来の解除としないようにタイミングをとるための時間です。未設定の場合の初期値は1秒です。
キー入力が可能かどうかはキーボードロックの解除後キーアンロックタイムだけ待ち、なおキーボードロック解除状態が続いていればキー入力可能と判断します。逆にキーアンロックタイム待ち中にキーボードロックになれば、はじめからキーボードロックの解除を待ちます。関数呼び出し時にすでにキーボードロックが解除されていてもキーアンロック時間だけ待ちます。

●呼び出し形式

SetKeyUnlockTime(Second, MiliSecond)

●パラメータ

パラメータ	説明	省略時の初期値
Second	キーアンロックタイムを秒で指定します。	省略できません
MiliSecond	キーアンロックタイムをミリ秒で指定します。Secondで指定された秒に加算します。 HTMLモードでのみ利用可能です。	0

●リターン値

●使用例

SetKeyUnlockTime(2)

●参照

次の関数でキーアンロックタイムが使用されます。

Type関数
Wait関数

■SetPrivateValue

スクリプト変数値の設定

ユーザースクリプトからマクロ機能を使用する場合、本関数を利用してスクリプト変数値をマクロに保存します。保存されたスクリプト変数値はGetPrivateValue関数で取得できます。

本関数はHTMLモードでのみ利用可能です。

●呼び出し形式

SetPrivateValue(Val, Value)

●パラメータ

パラメータ	説明	省略時の初期値
Val	文字列で指定されたスクリプト変数名	省略できません
Value	スクリプト変数に代入される設定値	省略できません

●リターン値

●使用例

SetPrivateValue("val1", 100) ;スクリプト変数に100を格納します。

■SetWaitTime

最大待ち時間の設定

Type関数、Wait関数の最大待ち時間を設定します。未設定の場合の初期値は20秒です。

●呼び出し形式

SetWaitTime(Second)

●パラメータ

パラメータ	説明	省略時の初期値
Second	（1～65535）	省略できません

●リターン値

●使用例

SetWaitTime(2)

●参照

次の関数で最大待ち時間が使用されます。

Type関数
Wait関数

■Sleep

指定時間実行を停止

指定時間だけマクロの実行を一時的に停止します。

●呼び出し形式

Sleep(Second)

●パラメータ

パラメータ	説明	省略時の初期値
Second	スリープ時間を秒で指定します。	省略できません

●リターン値

●使用例

Sleep(2)

■Small

小なり比較

第一パラメータで指定した値が第二パラメータで指定した値より小さいかを比較します。比較するパラメータに異なる型は指定できません。

●呼び出し形式

Small(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	整数値、文字列	省略できません
Val2	整数値、文字列	省略できません

●リターン値

関数の呼び出しに成功し、第一パラメータの値が第二パラメータの値より小さい場合はTRUEを返します。第一パラメータの値が第二パラメータの値より大きい場合や等しい場合、およびエラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。第一パラメータの値が第二パラメータの値より大きい場合や等しい場合はGetError関数では0（正常）が返ります。

●使用例

CrtInt(Val1, 10) ; 変数「Val1」を定義(初期値に20を代入)します。
Small(Val1, 20)  ; 変数「Val1」の値と20を比較しTRUEを返却します。

■Start

セッションの起動

指定の接続パス名のセッションを起動します。

●呼び出し形式

Start(PathName)

●パラメータ

パラメータ	説明	省略時の初期値
PathName	接続パス名 (DSP1,DSP2,DSP3,DSP4,PRN)	省略できません

●リターン値

●使用例

Start("DSP1") ; ディスプレイセッション１を起動

■Stop

セッションの終了

アクティブセッションを終了します。

●呼び出し形式

Stop()

●パラメータ

ありません

●リターン値

●使用例

Stop()

■Sub

数値の減算

第一パラメータで指定した整数値から第二パラメータで指定した整数値を減算します。

●呼び出し形式

Sub(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	減算される整数値	省略できません
Val2	減算する整数値	省略できません

●リターン値

●使用例

CrtInt(Val1, 10)               ; 変数「Val1」を定義(初期値に10を代入)します。
PutValue(Val1, Sub(Val1, 10))  ; 変数「Val1」から10を減算して0を返却します。

■Sur

数値除算の剰余を取得

第一パラメータで指定した整数値を第二パラメータで指定した整数値で除算し、剰余を返却します。

●呼び出し形式

Sur(Val1, Val2)

●パラメータ

パラメータ	説明	省略時の初期値
Val1	除算される整数値	省略できません
Val2	除算する整数値	省略できません

●リターン値

関数の呼び出しに成功すると演算結果の剰余を返します。剰余がない場合は0を返します。エラーが発生した場合は-1を返します。リターン値が-1の場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

CrtInt(Val1, 11)              ; 変数「Val1」を定義(初期値に11を代入)します。
PutValue(Val1, Sur(Val1, 10)) ; 変数「Val1」の値を10で除算して余り1を返却します。

■ToInt

数字文字列の数値変換

パラメータに指定された数字文字列を数値に変換します。文字列で小数が表現されている場合は小数点以下を切り捨て、整数値のみを返します。

●呼び出し形式

ToInt(String)

●パラメータ

パラメータ	説明	省略時の初期値
String	文字列	省略できません

●リターン値

関数の呼び出しに成功すると変換した整数値を返します。変換結果が-1の場合、またはエラーが発生した場合は-1を返します。リターン値が-1の場合はGetError関数を使ってエラー番号を調べることができます。変換結果が-1の場合はGetError関数では0（正常）が返ります。

●使用例

CrtString(Val1, "100") ;「Val1」という文字列変数を定義します。
ToInt(Val1)            ; 変数「Val1」を整数に変換して、100が返却されます。

■ToString

数値の文字列変換

パラメータに指定された数値を文字列に変換します。パラメータに整数値が指定された場合は半角数字を返します。パラメータに論理値が指定された場合は"TRUE"または"FALSE"のどちらかの文字列を半角大文字で返します。

●呼び出し形式

ToString(Val)

●パラメータ

パラメータ	説明	省略時の初期値
Val	整数値、論理値	省略できません

●リターン値

関数の呼び出しに成功すると変換後の文字列を返します。エラーが発生した場合は空文字を返します。リターン値が空文字の場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

CrtInt(Val1, 123)        ;「Val1」という整数型変数を定義します。
CrtBoolean(Val2, TRUE)   ;「Val2」という論理値変数を定義します。
ToString(Val1)           ; 変数「Val1」を文字列に変換して、"123"と返却します。
ToString(Val2)           ; 変数「Val2」を文字列に変換して、"TRUE"と返却します。

■Type

キーの入力

キー入力をエミュレーションします。キーボードロック状態の場合はキー入力が可能になるのを待ってから入力を行います。最大待ち時間はSetWaitTime関数で設定された待ち時間だけ待ちます。キーアンロック時間はSetKeyUnlockTime関数で任意の時間に設定できます。
入力禁止フィールドにキーを入力しようとしたり、この関数により入力禁止状態になった場合はすぐにエラー復帰します。
入力キーに特殊キーやJEFコードを含める時は[ENTER]のようにカッコ[ ]で囲みます。カッコ内は1つの項目だけ指定可能です。左カッコ[ を入力するときは左カッコを重ねて書きます。
また、入力文字列として数値型を指定する場合は、ToString関数で数値を文字列に変換する必要があります。

●呼び出し形式

Type(Text, Row, Col)

●パラメータ

パラメータ	説明	省略時の初期値
Text	入力文字列	省略できません
Row	入力開始行（1～24）	カーソル位置
Col	入力開始桁（1～80）	カーソル位置

●リターン値

●特殊キーの指定一覧

機能	記述形式	機能	記述形式
PF1	[PF1]	実行	[ENTER]
PF2	[PF2]	PA1	[PA1]
PF3	[PF3]	PA2	[PA2]
PF4	[PF4]	PA3	[PA3]
PF5	[PF5]	CLEAR	[CLEAR]
PF6	[PF6]	SYSREQ	[SYSREQ]
PF7	[PF7]	ATTN	[ATTN]
PF8	[PF8]	→	[RIGHT]
PF9	[PF9]	←	[LEFT]
PF10	[PF10]	↑	[UP]
PF11	[PF11]	↓	[DOWN]
PF12	[PF12]	タブ	[TAB]
PF13	[PF13]	バックタブ	[BACKTAB]
PF14	[PF14]	改行	[RETURN]
PF15	[PF15]	HOME	[HOME]
PF16	[PF16]	挿入	[INSERT]
PF17	[PF17]	削除	[DELETE]
PF18	[PF18]	ERASE INPUT	[ERASEINPUT]
PF19	[PF19]	ERASE EOF	[ERASEEOF]
PF20	[PF20]	RESET	[RESET]
PF21	[PF21]	CURSOR SELECT	[CURSORSEL]
PF22	[PF22]	DUP	[DUPLICATE]
PF23	[PF23]	FIELD MARK	[FIELDMARK]
PF24	[PF24]	+入力	[+ENTER]

●使用例

; 文字列 + 実行キー
Type("LOGON TSS [ENTER]")

; JEFコード入力
Type("[41A1][41A2]")

■TypeKey

キーの1文字即時入力

1文字分のキー入力をエミュレーションします。キーボードロック状態の場合はエラー復帰します。Type関数と違いキー入力可能になるのを待ちません。

入力キーにはType関数と同様の形式で特殊キーやJEFコードを指定できます。ただし、1文字分のキーしか指定できません。
特殊キーの記述形式はType関数を参照してください。

●呼び出し形式

TypeKey(Text)

●パラメータ

パラメータ	説明	省略時の初期値
Text	入力文字	省略できません

●リターン値

●使用例

; 特殊文字
TypeKey("[RESET]")

; JEFコード入力
TypeKey("[41A1]")

■Wait

指定文字列の受信待ち

指定文字列を受信するのを待ちます。この関数はキー入力が可能になってから指定された文字列を受信したかを判定します。最大待ち時間はSetWaitTime関数で設定された待ち時間だけ待ちます。キーアンロック時間はSetKeyUnlockTime関数で任意の時間に設定できます。
パラメータをすべて省略するとキー入力が可能になるのを待つことができます。

●呼び出し形式

Wait(Text,Row1, Col1, Row2, Col2)

●パラメータ

パラメータ	説明	省略時の初期値
Text	受信待ち文字列	省略時はキー入力可を待ちます
Row1	受信待ち開始行（1～24）	1
Col1	受信待ち開始桁（1～80）	1
Row2	受信待ち終了行（1～24）	24
Col2	受信待ち終了桁（1～80）	80

●リターン値

文字列を受信した場合はTRUEを返します。エラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。

●使用例

; SYSTEM READYの受信を待ちます
Wait("SYSTEM READY",1, 1)

; キー入力可能になるのを待ちます
Wait()