ページの先頭行へ戻る
WSMGR for Web V7.2 使用手引書L10

22.3.3 関数

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

関数名

Activate

アクティブセッションの設定

Bye

エミュレータの終了

CmpText

文字列の比較

CopyField

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

CopyLn

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

CopyRc

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

CopyScreen

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

Dialog

ダイアログの表示

EnableKeyborad

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

EndDialog

ダイアログの終了

Exec

コマンドの実行

Exit

マクロの実行中止

Equ

比較

GetError

エラー番号の取り出し

GetResult

結果コードの取り出し

IsKeyboardLock

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

IsProtectPos

入力禁止位置の確認

IsFieldTopPos

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

IsFieldEndPos

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

IsNumField

数字フィールドの確認

MsgBox

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

Not

論理反転

Paste

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

Scan

文字列検索

SetCursorPos

カーソル位置の設定

SetKeyUnlockTime

キーアンロック時間の設定

SetWaitTime

最大待ち時間の設定

Sleep

指定時間実行を停止

Start

セッションの起動

Stop

セッションの終了

Type

キーの入力

TypeKey

キーの1文字即時入力

Wait

ホストからの文字列待ち合わせ

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

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

Activate

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

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


●呼び出し形式

Activate(PathName)

●パラメータ

パラメータ

説明

省略時の初期値

PathName

接続パス名
(DSP1,DSP2,DSP3,DSP4,PRN)

省略できません


●リターン値

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


●使用例

Activate("DSP1")// ディスプレイセッション1に切り替える

Bye

エミュレータの終了

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


●呼び出し形式

Bye(ResultCode)

●パラメータ

パラメータ

説明

省略時の初期値

ResultCode

意味をもちません

省略できません


●使用例

Bye(0)

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)

カーソル位置


●リターン値

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


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


●リターン値

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


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


●リターン値

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


CopyScreen

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

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


●呼び出し形式

CopyScreen()

●パラメータ

ありません


●リターン値

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


Dialog

ダイアログの表示

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


●呼び出し形式

Dialog(Template)

●パラメータ

パラメータ

説明

省略時の初期値

Template

ダイアログテンプレート名

省略できません


●リターン値

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


■EnableKeyboard

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

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

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


●呼び出し形式

        EnableKeyboard (Val)

●パラメータ

パラメータ

説明

省略時のデフォルト値

Val

入力許可時の指定(TRUE)

省略できません

入力禁止時の指定(FALSE)

省略できません


●リターン値

ありません


EndDialog

ダイアログの終了

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


●呼び出し形式

EndDialog(ResultCode)

●パラメータ

パラメータ

説明

省略時の初期値

ResultCode

処理結果コード

0


●リターン値

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


Exec

子プロセスの起動

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


●呼び出し形式

Exec(CmdLine)

●パラメータ

パラメータ

説明

省略時の初期値

CmdLine

コマンドライン

省略できません


●リターン値

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


●使用例

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

Exit

マクロの実行中止

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


●呼び出し形式

Exit()

●パラメータ

ありません


●リターン値

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


Equ

比較

2つのパラメータの値を比較します。


●呼び出し形式

Equ(Param1, Param2)

●パラメータ

パラメータ

説明

省略時の初期値

Param1

比較する第1パラメータ

省略できません

Param2

比較する第2パラメータ

省略できません


●リターン値

2つのパラメータが等しい場合はTRUEを、等しくない場合はFALSEを返します。


●使用例

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

Type("ABC")

IF( Equ(GetError(), ERROR_DNYKEY) )

      Type("[RESET]")
ENDIF

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

未サポート関数が呼び出されました。


GetResult

結果コードの取得

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


●呼び出し形式

GetResult()

●パラメータ

ありません


●リターン値

結果コードを表します。


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を返します。


MsgBox

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

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


●呼び出し形式

MsgBox(Text, Style)

●パラメータ

パラメータ

説明

省略時の初期値

Text

表示する文字列

省略できません

Style

OK、OKCANCEL、YESNOのいずれかを指定します。

OKスタイルを持ちます


●リターン値

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

スタイル

押されたボタン

リターン値

OK

[OK]

TRUE

OKCANCEL

[OK]

TRUE

[キャンセル]

FALSE

YESNO

[はい]

TRUE

[いいえ]

FALSE


●使用例

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

Not

反転

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


●呼び出し形式

Not(Val)

●パラメータ

パラメータ

説明

省略時の初期値

Val

値を持ったパラメータ

省略できません


●リターン値

反転結果を返します。


●使用例

IF( Not( 0 ) )

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

Paste

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

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


●呼び出し形式

Paste()

●パラメータ

ありません


●リターン値

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


●使用例

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

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関数を使ってエラー番号を調べることができます。


●使用例

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

SetCursorPos

カーソル位置の設定

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


●呼び出し形式

SetCursorPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

カーソル行(1~24)

省略できません

Col

カーソル桁(1~80)

省略できません


●リターン値

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


SetKeyUnlockTime

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

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


●呼び出し形式

SetKeyUnlockTime(Second)

●パラメータ

パラメータ

説明

省略時の初期値

Second

キーアンロックタイムを秒で指定します。

省略できません


●リターン値

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


●使用例

SetKeyUnlockTime(2)

●参照

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

Type関数
Wait関数

SetWaitTime

最大待ち時間の設定

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


●呼び出し形式

SetWaitTime(Second)

●パラメータ

パラメータ

説明

省略時の初期値

Second

(1~65535)

省略できません


●リターン値

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


●使用例

SetWaitTime(2)

●参照

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

Type関数
Wait関数

Sleep

指定時間実行を停止

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


●呼び出し形式

Sleep(Second)

●パラメータ

パラメータ

説明

省略時の初期値

Second

スリープ時間を秒で指定します。

省略できません


●リターン値

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


●使用例

Sleep(2)

Start

セッションの起動

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


●呼び出し形式

Start(PathName) 

●パラメータ

パラメータ

説明

省略時の初期値

PathName

接続パス名
(DSP1,DSP2,DSP3,DSP4,PRN)

省略できません


●リターン値

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


●使用例

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

Stop

セッションの終了

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


●呼び出し形式

Stop() 

●パラメータ

ありません


●リターン値

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


●使用例

Stop()

Type

キーの入力

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


●呼び出し形式

Type(Text, Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Text

入力文字列

省略できません

Row

入力開始行(1~24)

カーソル位置

Col

入力開始桁(1~80)

カーソル位置


●リターン値

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


●特殊キーの指定一覧

機能

記述形式

機能

記述形式

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]

PF12

[PF12]

バックタブ

[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]

PF22

[PF22]

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

入力文字

省略できません


●リターン値

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


●使用例

; 特殊文字
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()