8.3.4 関数

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

関数名	機能
Add	整数の加算
AddEscape	エスケープ文字の付加
And	論理積
Att	文字列の連結
Bye	ディスプレイエミュレータの終了
CmpText	文字列の比較
CopyField	クリップボードへの複写（フィールド）
CopyLn	クリップボードへの複写（行範囲）
CopyRc	クリップボードへの複写（矩形範囲）
CopyScreen	クリップボードへの複写（全画面）
CrtBoolean	論理値型変数の作成
CrtInt	整数型変数の作成
CrtString	文字列型変数の作成
Dialog	ダイアログの表示
Div	整数の除算
EnableKeyboard	マクロ実行時のキーボード／マウス入力の設定
EndDialog	ダイアログの終了
Equ	比較
Exec	コマンドの実行
Exit	マクロの実行中止
GetEnvironmentVariable	環境変数値の取得
GetError	エラー番号の取得
GetLength	文字列長の取得
GetResult	結果コードの取得
GetString	画面から文字列の取得
InputBox	入力ボックスの表示
IsFieldEndPos	フィールド最終位置の確認
IsFieldTopPos	フィールド先頭位置の確認
IsKeyboardLock	キーボードロック状態の確認
IsNumField	数字フィールドの確認
IsProtectPos	入力禁止位置の確認
Large	大なり比較
MsgBox	メッセージボックスの表示
Mul	整数の乗算
Not	論理反転
Or	論理和
Paste	クリップボードからの貼り付け
PutValue	変数値の代入
Scan	文字列検索
SetCursorPos	カーソル位置の設定
SetKeyUnlockTime	キーアンロックタイムの設定
SetWaitTime	最大待ち時間の設定
Sleep	指定時間実行を停止
Small	小なり比較
Sub	整数の減算
SubString	文字列の一部の取得
Sur	整数の剰余
ToInt	数値変換
ToString	文字列変換
Trim	前後の空白文字の削除
Type	キーの入力
TypeKey	キーの1文字即時入力
Wait	指定文字列の受信待ち

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

例）

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

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

■Att

文字列の連結

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

●呼び出し形式

        Att(String1, String2)

●パラメータ

パラメータ	説明	省略時のデフォルト値
String1	文字列	省略できません
String2	文字列	省略できません

●リターン値

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

●使用例

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

■Bye

ディスプレイエミュレータの終了

ディスプレイエミュレータを終了させます。セッションが起動されている場合はセッションを強制終了してから終了します。

●呼び出し形式

        Bye(ResultCode)

●パラメータ

パラメータ	説明	省略時のデフォルト値
ResultCode	意味を持ちません	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

クリップボードへの複写（フィールド）

指定位置のフィールド内範囲をクリップボードへ複写します。クリップボードには、CF_TEXT形式のデータが置かれます。

●呼び出し形式

        CopyField(Row, Col)

●パラメータ

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

●リターン値

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

■CopyLn

クリップボードへの複写（行範囲）

指定位置で囲まれる行範囲をクリップボードへ複写します。クリップボードには、CF_TEXT形式のデータが置かれます。

●呼び出し形式

        CopyLn(Row1, Col1, Row2, Col2)

●パラメータ

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

●リターン値

■CopyRc

クリップボードへの複写（矩形範囲）

指定位置で囲まれる矩形範囲をクリップボードへ複写します。クリップボードには、CF_TEXT形式のデータが置かれます。

●呼び出し形式

        CopyRc(Row1, Col1, Row2, Col2)

●パラメータ

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

●リターン値

■CopyScreen

クリップボードへの複写（全画面）

全画面範囲をクリップボードへ複写します。クリップボードには、CF_TEXT形式のデータが置かれます。

●呼び出し形式

        CopyScreen()

●パラメータ

ありません

●リターン値

■CrtBoolean

論理値型変数の作成

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

●呼び出し形式

        CrtBoolean(Val, Initval)

●パラメータ

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

●リターン値

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

●使用例

        CrtBoolean(Val, TRUE)   ; 変数「Val」をTRUEで初期化して定義します。

■CrtInt

整数型変数の作成

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

●呼び出し形式

        CrtInt(Val, Initval)

●パラメータ

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

●リターン値

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

●使用例

        CrtInt(Val, 65535)  ; 変数「Val」を65535で初期値して定義します。

■CrtString

文字列型変数の作成

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

●呼び出し形式

        CrtString(Val, Initval)

●パラメータ

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

●リターン値

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

●使用例

        CrtString(Val, "VALUE")   ; 変数「Val」を"VALUE"で初期化して定義します。

■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キー）として動作します。また、マクロ実行キーは入力しても無視されます。

●呼び出し形式

        EnableKeyboard (Val)

●パラメータ

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

●リターン値

ありません

■EndDialog

ダイアログの終了

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

●呼び出し形式

        EndDialog(ResultCode)

●パラメータ

パラメータ	説明	省略時のデフォルト値
ResultCode	処理結果コード	0

●リターン値

■Equ

比較

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

●呼び出し形式

        Equ(Param1, Param2)

●パラメータ

パラメータ	説明	省略時のデフォルト値
Param1	比較する第1パラメータ	省略できません
Param2	比較する第2パラメータ	省略できません

●リターン値

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

●使用例

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

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

■Exec

コマンドの実行

プログラムを呼び出します。呼び出したプログラムの終了を待たずにこの関数は制御を戻します。プログラムの起動結果は GetResult 関数で調べることができます。

●呼び出し形式

        Exec(CmdLine)

●パラメータ

パラメータ	説明	省略時のデフォルト値
CmdLine	コマンドライン	省略できません

●リターン値

●使用例

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

■Exit

マクロの実行中止

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

●呼び出し形式

        Exit()

●パラメータ

ありません

●リターン値

■GetEnvironmentVariable

環境変数値の取得

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

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

●呼び出し形式

        GetEnvironmentVariable(Name)

●パラメータ

パラメータ	説明	省略時のデフォルト値
Name	環境変数名	省略できません

●リターン値

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

●使用例

        GetEnvironmentVariable("WSMGR_TNHOSTNAME")  ; 端末のホスト名を取得します。
        GetEnvironmentVariable("WSMGR_TNIPADDR")    ; 端末のIPアドレスを取得します。

■GetError

エラー番号の取得

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

●呼び出し形式

        GetError()

●パラメータ

ありません

●リターン値

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

値 (エラー番号)	意味
ERROR_NONE (0)	エラーはありません。
ERROR_NOMEMORY (2)	メモリ不足が発生しました。
ERROR_ABORT (12)	セッションが異常終了しました。
ERROR_TIMEOUT (13)	タイムアウトが発生しました。
ERROR_FILENOTEXIST (19)	Exec関数で指定されたプログラムが見つかりません。
ERROR_NOEXEC (20)	Exec関数で指定されたプログラムが実行できませんでした。
ERROR_NOSCAN (22)	Scan関数で文字列が見つかりませんでした。
ERROR_DNYKEY (23)	キー入力禁止でした。
ERROR_NOSUPPORT (24)	未サポート関数が呼び出されました。

●使用例

CrtString(ErrMsg, "キー入力に失敗しました。エラー番号：")     ; 変数「ErrMsg」を初期化して定義します
IF(TYPE("ABC[ENTER]"))
      MsgBox("キー入力に成功しました。")                      ; 成功時のメッセージを表示します
ELSE
      PutValue(ErrMsg, Att(ErrMsg, ToString(GetError())))     ; エラー番号を連結します
      MsgBox(ErrMsg)                                          ; 失敗時のメッセージを表示します
ENDIF

■GetLength

文字列長の取得

指定された文字列の文字数を取得します。

●呼び出し形式

        GetLength(Val)

●パラメータ

パラメータ	説明	省略時のデフォルト値
Val	文字列	省略できません

●リターン値

関数の呼び出しに成功すると、文字列に含まれる文字数を半角換算して返します。失敗の場合-1を返します。リターン値が-1 の場合は GetError 関数を使ってエラー番号を調べることができます。

●使用例

        CrtString(STR)          ;「STR」という文字列型変数を定義します。
        PutValue(STR, "X")      ; STRに"X"を設定します。
        GetLength(STR)          ; STRの文字数を取得して、1を返却します。

■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（正常）が返ります。

●使用例

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

■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")

■IsFieldEndPos

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

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

●呼び出し形式

        IsFieldEndPos(Row, Col)

●パラメータ

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

●リターン値

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

■IsFieldTopPos

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

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

●呼び出し形式

        IsFieldTopPos(Row, Col)

●パラメータ

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

●リターン値

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

●使用例

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

■IsKeyboardLock

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

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

●呼び出し形式

        IsKeyboardLock()

●パラメータ

ありません

●リターン値

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

●使用例

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

■IsNumField

数字フィールドの確認

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

●呼び出し形式

        IsNumField(Row, Col)

●パラメータ

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

●リターン値

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

■IsProtectPos

入力禁止位置の確認

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

●呼び出し形式

        IsProtectPos(Row, Col)

●パラメータ

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

●リターン値

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

●使用例

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

■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	値を持ったパラメータ	省略できません

●リターン値

反転結果を返します。

●使用例

        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

クリップボードからの貼り付け

クリップボード内容を現在のカーソル位置へ貼り付けます。キー入力禁止状態のときはエラー復帰します。

●呼び出し形式

        Paste()

●パラメータ

ありません

●リターン値

●使用例

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

■PutValue

変数値の代入

定義済みの変数への値の代入が可能です。

注意

未定義の変数は指定できません。
代入する値と代入先の変数の型は一致している必要があります。

●呼び出し形式

        PutValue (name, val)

●パラメータ

パラメータ	説明	省略時のデフォルト値
name	代入先の変数名	省略できません
val	変数への代入値	省略できません

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

●リターン値

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

●使用例

        CrtInt(A, 10)         ;「A」という整数型変数を定義して、10で初期化します。
        PutValue(A, 20)       ; 変数「A」に20を代入します。

■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）	省略できません

●リターン値

■SetKeyUnlockTime

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

キーアンロックタイムは、キーボードロック中に一瞬ロックが解除されることがあるため、この解除を本来の解除としないようにタイミングをとるための時間です。未設定の場合のデフォルト値は1秒です。

キー入力が可能かどうかはキーボードロックの解除後キーアンロックタイムだけ待ち、なおキーボードロック解除状態が続いていればキー入力可能と判断します。逆にキーアンロックタイム待ち中にキーボードロックになれば、初めからキーボードロックの解除を待ちます。関数呼び出し時にすでにキーボードロックが解除されていてもキーアンロック時間だけ待ちます。

●呼び出し形式

        SetKeyUnlockTime(Second)

●パラメータ

パラメータ	説明	省略時のデフォルト値
Second	キーアンロックタイムを秒で指定します。	省略できません

●リターン値

●使用例

        SetKeyUnlockTime(2)

●参照

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

        Type 関数
        Wait 関数

■SetWaitTime

最大待ち時間の設定

Type 関数、 Wait 関数の最大待ち時間を設定します。未設定の場合のデフォルト値は20秒です。

●呼び出し形式

        SetWaitTime(Second)

●パラメータ

パラメータ	説明	省略時のデフォルト値
Second	（1～65525）	省略できません

●リターン値

●使用例

        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」を定義(初期値に10を代入)します。
        Small(Val1, 20)    ; 変数「Val1」の値と20を比較しTRUEを返却します。

■Sub

整数の減算

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

●呼び出し形式

        Sub(Val1, Val2)

●パラメータ

パラメータ	説明	省略時のデフォルト値
Val1	整数	省略できません
Val2	整数	省略できません

●リターン値

●使用例

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

■SubString

文字列の一部の取得

指定された文字列の一部を取得します。

●呼び出し形式

        SubString (string, position, length)

●パラメータ

パラメータ	説明	省略時のデフォルト値
string	文字列	省略できません
position	開始位置	1
length	文字数	文字列の末尾まで取得します

●リターン値

関数の呼び出しに成功した場合、文字列の一部を返します。

関数の呼び出しに失敗した場合、空の文字列""を返し、エラー番号に該当するエラー番号を設定します。

関数が正常に終了したか否かを判断するには、GetError関数を使用してエラー番号を調べることができます。

●使用例

        CrtString(V1, "ABCD")  ;「V1」という文字列変数を定義します。
        SubString(V1, 1, 2)    ; "AB"を返却します。

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

■Trim

前後の空白文字の削除

パラメータ文字列の両端の空白を削除します。

●呼び出し形式

        Trim(string)

●パラメータ

パラメータ	説明	省略時のデフォルト値
string	文字列	省略できません

●リターン値

関数の呼び出しに成功した場合、両端の空白(半角空白と全角空白)が削除された文字列を返します。

関数の呼び出しに失敗した場合、空の文字列""を返し、エラー番号に該当するエラー番号を設定します。

関数が正常に終了したか否かを判断するには、GetError関数を使用してエラー番号を調べることができます。

●使用例

        CrtString(V, "ABCD")  ;「V」という文字列変数を定義します。
        Trim(V)               ; 変数「V」の両端の空白を削除し、"ABCD"を返却します。

■Type

キーの入力

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

●呼び出し形式

        Type(Text, Row, Col)

●パラメータ

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

●リターン値

●特殊キーの指定一覧

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

●リターン値

●使用例

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

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