ページの先頭行へ戻る
WSMGR for Web V7.2 使用手引書L20
第7部 マクロ編 > 第24章 スクリプト（ActiveXモード） > 24.4 F5AAUIMAINリファレンス
前次

24.4 F5AAUIMAINリファレンス

使用可能なメソッドの一覧を示します。各メソッドの中には、引数が必要であったり、引数が省略された時のデフォルト動作をするものがあります。

メソッド名

機能

Activate

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

Bye

エミュレータの終了

ChangeProfile

ディスプレイ・プリンタプロファイルを変更する

ChangeSessionProperty

TNサーバアドレス、LU名、ポート番号を変更する

CmpText

画面上の文字列と比較

CopyField

クリップボードへの複写

CopyLn

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

CopyRc

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

CopyScreen

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

EnableKeyboard

HTML実行中のキー入力許可

ExecMacro

マクロファイルの実行

GetError

エラー番号の取得

IsConnected

アクティブセッションの接続状態の確認

IsKeyboardLock

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

IsProtectPos

入力禁止位置の確認

IsFieldTopPos

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

IsFieldEndPos

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

IsNumField

数字フィールドの確認

MsgBox

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

Paste

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

Scan

画面上の文字列を検索

SetCursorPos

カーソル位置の設定

SetKeyUnlockTime

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

SetWaitTime

最大待ち時間の設定

Sleep

指定時間実行を停止

Start

セッションの接続

Stop

セッションの切断

Type

キー入力

TypeKey

キーの1文字即時入力

Wait

指定文字列の受信待ち

引数を省略する時は、後ろの引数から順番に省略できます。途中の引数を省略することはできません。

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

■Activate

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

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


●呼び出し形式

Activate(PathName)

●パラメータ

パラメータ

説明

省略時の初期値

PathName

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

省略できません


●リターン値

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


●JavaScriptを用いて記述した例

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

■Bye

エミュレータの終了

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


●呼び出し形式

Bye()

●パラメータ

ありません。


●リターン値

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


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.Bye();  // エミュレータを終了する
// エミュレータがdspemuフレームに存在する場合
Window.open("default.htm","dspemu")         //エミュレータを終了する

■ChangeSessionProperty

TNサーバアドレス、LU名、TNポート番号の変更

TNサーバーアドレス、LU名、TNのポート番号の変更を即時変更します。変更した値が保存されることはなく、次回起動時には変更前のプロパティ値へ戻ります。


●呼び出し形式

ChangeSessionProperty(PathName, PropName, PropValue)

●パラメータ

パラメータ

説明

省略時の初期値

PathName

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

省略できません

PropName

設定を変更するプロパティ

  1. TNサーバアドレス(TnServerAddress)

  2. LU名(TnLuName)

  3. TNポート番号(TnPortNum)

省略できません

PropValue

設定を変更するプロパティの値

  1. サーバ名またはIPアドレス

  2. LU名

  3. 0～65535

省略できません


LU名を削除する場合は””を設定してください


●リターン値

関数の呼び出しに成功するとTRUEを返します。プロパティ変更に失敗した場合、または異常終了の場合、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

// セッション１のTNサーバーアドレスを192.1.1.1に変更する。
F5AAUIMAIN.Macro.ChangeSessionProperty(
                    "dsp1"，"TnServerAddress"，"192.1.1.1");

注意

このメソッドは、エミュレータの設定の変更を許可されたユーザのみ成功します。


■ChangeProfile

プロフィルの変更

ディスプレイ、プリンタプロファイルを変更します。


●呼び出し形式

ChangeProfile(ProfileKind, ProfileName)

●パラメータ

パラメータ

説明

省略時の初期値

ProfileKind

変更するプロファイル
ディスプレイプロファイル変更
(DSPPROFILE)
プリンタプロファイル変更
(PRNPROFILE)

省略できません

ProfileName

変更するプロファイル名

省略できません


●リターン値

関数の呼び出しに成功するとTRUEを返します。指定のプロファイルと現在のプロファイルが同一の場合はTRUEを返します。プロファイル変更に失敗した場合、または異常終了の場合FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

// ディスプレイプロファイルを現在のプロファイルから"6680標準"に変更する
F5AAUIMAIN.Macro. ChangeProfile("DSPPROFILE"，"6680標準");

■CmpText

画面上の文字列と比較

画面上の指定位置に表示されている文字列と比較します。比較結果は、復帰値により確認することができます。


●呼び出し形式

CmpText(Text, Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Text

比較する文字列

省略できません

Row

比較開始行位置（1～24）

カーソル位置

Col

比較開始桁位置（1～80）

カーソル位置


●リターン値

関数の呼び出しに成功するとTRUEを返します。指定位置の文字列と一致しなかった場合、またはエラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。
画面上の文字は、ディスプレイプロファイル設定の入出力モードの英数カナ変換に従ってコード変換するため、カナ文字を比較する場合は注意する必要があります。


●JavaScriptを用いて記述した例

if(F5AAUIMAIN.Macro.CmpText("A") == true)
    alert("現在のカーソルはAの上にあります");
else
    alert("現在のカーソルはA以外の上にあります");

■CopyField

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

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


●呼び出し形式

CopyField(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

複写範囲開始行位置（1～24）

カーソル位置

Col

複写範囲開始桁位置（1～80）

カーソル位置


●リターン値

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


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.CopyField(1, 40);// 1行目、40桁の位置のフィールド内範囲を複写

■CopyLn

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

指定位置で囲まれる行範囲をクリップボードへ複写します。クリップボードには、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関数を使ってエラー番号を調べることができます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.CopyLn(1, 1, 1, 80);  // 1行目を1桁から80桁までを複写

■CopyRc

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

指定位置で囲まれる矩形範囲をクリップボードへ複写します。クリップボードには、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関数を使ってエラー番号を調べることができます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.CopyRc(1, 1, 3, 80);  // 1行目を1桁から3行目80桁までを複写

■CopyScreen

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

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


●呼び出し形式

CopyScreen()

●パラメータ

ありません。


●リターン値

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


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.CopyScreen();  // 全画面を複写

■EnableKeyboard

キー入力許可・禁止

キー入力許可・禁止を設定します。

●呼び出し形式

EnableKeyboard(bEnable)

●パラメータ

パラメータ

説明

省略時の初期値

bEnable

TRUE：キー入力許可
FALSE：キー入力禁止

省略できません

引数にTUREを設定すると、DSPEMUへのキー入力を可能とします。引数にFALSEを設定すると、DSPEMUへの入力を禁止します。また、キーパッド、LU切り替えボタン、メニュー・ツールバーのマクロ関連（マクロ設定外）の操作が無効となります。


●リターン値

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


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.EnableKeyboard("TRUE");    // 入力許可
F5AAUIMAIN.Macro.EnableKeyboard("FALSE");   // 入力禁止

■ExecMacro

マクロファイルの実行

指定のマクロファイルを実行します。


●呼び出し形式

ExecMacro(MacroName)

●パラメータ

パラメータ

説明

省略時の初期値

MacroName

マクロファイル名

省略できません

マクロファイル名は、拡張子の「.scr」を省略して指定することが可能です。指定のマクロファイルが存在しない場合、FALSEで復帰します。エラーの詳細は、GetErrorメソッドにより取得できます。
マクロファイルの実行中は、通常のマクロ実行と同様に、メニュー、ツールバーがマクロ実行状態となり、状態表示行にマクロ実行が表示されます。マクロ実行が終了するか、または中断するまでこのメソッドは復帰しません。
マクロファイルの実行中はディスプレイエミュレータへの入力が禁止となります。また、LU切り替えボタン、メニュー・ツールバーのマクロ関連（マクロ設定以外）の操作が無効になります。ただし、以下のキーは有効です。

●リターン値

関数の呼び出しに成功するとTRUEを返します。エラーが発生した場合はFALSEを返します。リターン値がFALSEの場合はGetError関数を使ってエラー番号を調べることができます。
なお、リターン値はマクロの実行結果ではないので注意してください。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.ExecMacro("Test.scr");  // Test.scrマクロファイルを実行する

■GetError

エラー番号の取得

関数がエラー終了した時の最新のエラー番号を取得します。エラーが発生していない場合は、0を返します。


●呼び出し形式

GetError()

●パラメータ

ありません


●リターン値

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

エラーの詳細を求める前に別のメソッドが実行されると、直前に失敗したメソッドが設定したエラー番号に上書きされます。
このため、各メソッドの復帰値が失敗した値で返ってきた場合は、すぐにGetErrorメソッドを用いてエラーの詳細を求めてください。

復帰値

復帰値の意味

0

エラーはありません。

2

メモリ不足が発生しました。

4

Typeメソッドで無効なキーが指定されました。

12

セッションが異常終了しました。

13

タイムアウトが発生しました。

18

ホストと接続されていません。

20

ExecMacroメソッドで指定されたマクロファイルが実行できません。

22

文字列が見つかりませんでした。

23

キー入力禁止でした。

24

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

25

Startメソッドでセッションが起動できませんでした。

26

Stopメソッドでセッションが終了できませんでした。

27

セッションが未起動です。

50

スクリプト実行中につき実行できません。

51

プロパティの変更に失敗しました。

52

プロファイルの変更に失敗しました。

53

OLEオートメーション実行中につき実行できません。

100

致命的エラー(内部エラー、 複写失敗)です。


●JavaScriptを用いて記述した例

errcode = F5AAUIMAIN.Macro.GetError();
alert("エラー番号：" + errcode + " が発生しました");

■IsConnected

アクティブセッションの接続状態の確認

アクティブセッションの接続状態を確認します。


●呼び出し形式

IsConnected()

●パラメータ

ありません


●リターン値

関数を呼び出した時にアクティブセッションが接続状態の場合はTRUEを返します。未接続状態の場合はFALSEを返します。


●JavaScriptを用いて記述した例

if(F5AAUIMAIN.Macro.IsConnected() == true)
    alert("接続状態です");
else
    alert("未接続状態です");

■IsKeyboardLock

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

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


●呼び出し形式

IsKeyboardLock()

●パラメータ

ありません


●リターン値

関数を呼び出した時にキー入力禁止の場合はTRUEを返します。キー入力可能の場合または異常終了時は、FALSEを返します。エラー詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

if(F5AAUIMAIN.Macro.IsKeyboardLock() == true)
    alert("キー入力できない状態です");

■IsProtectPos

入力禁止位置の確認

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


●呼び出し形式

IsProtectPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

確認行位置（1～24）

カーソル位置

Col

確認桁位置（1～80）

カーソル位置


●リターン値

関数を呼び出した時に指定位置がキー入力禁止位置の場合はTRUEを返します。キー入力可能位置の場合、または異常終了時は、FALSEを返します。エラー詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

if(F5AAUIMAIN.Macro.IsProtectPos(2, 10) == true)
    alert("2行10桁目は、キー入力禁止位置です");

■IsFieldTopPos

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

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


●呼び出し形式

IsFieldTopPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

確認行位置（1～24）

カーソル位置

Col

確認桁位置（1～80）

カーソル位置


●リターン値

関数を呼び出した時に指定位置がフィールドの先頭位置の場合はTRUEを返します。それ以外の位置、アトリビュート文字位置、または異常終了の場合FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。不定様式画面の場合、1行1桁目がフィールドの先頭位置として扱われます。


●JavaScriptを用いて記述した例

if(!F5AAUIMAIN.Macro.IsFieldTopPos() == true)
    F5AAUIMAIN.Macro.TypeKey("[BACKTAB]");  // フィールドの先頭へカーソル移動

■IsFieldEndPos

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

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


●呼び出し形式

IsFieldEndPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

確認行位置（1～24）

カーソル位置

Col

確認桁位置（1～80）

カーソル位置


●リターン値

関数を呼び出した時に指定位置がフィールドの最終位置の場合はTRUEを返します。それ以外の位置、アトリビュート文字位置、または異常終了の場合、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。不定様式画面の場合、24行80桁目がフィールドの最終位置として扱われます。


●JavaScriptを用いて記述した例

if(F5AAUIMAIN.Macro.IsFieldEndPos() == true)
      alert("フィールドの最終位置です");

■IsNumField

数字フィールドの確認

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


●呼び出し形式

IsNumField(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

確認行位置（1～24）

カーソル位置

Col

確認桁位置（1～80）

カーソル位置


●リターン値

関数を呼び出した時に指定位置のフィールドが数字フィールドの場合はTRUEを返します。数字フィールドでない場合、または異常終了の場合、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

if(F5AAUIMAIN.Macro.IsNumField() == true)
      alert("数字フィールド位置です");

■MsgBox

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

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


●呼び出し形式

MsgBox(Text, Style)

●パラメータ

パラメータ

説明

省略時の初期値

Text

表示する文字列

省略できません

Style

OK、OKCANCEL、YESNOのいずれかを指定する

OKスタイルになります


●リターン値

スタイルと押されたボタンによって次の値が返されます。
エラーの詳細は、GetErrorメソッドにより取得できます。

スタイル

押されたボタン

復帰値

OK

[OK]

TRUE

OKCANCEL

[OK]

TRUE

[キャンセル]

FALSE

YESNO

[はい]

TRUE

[いいえ]

FALSE


●JavaScriptを用いて記述した例

if(F5AAUIMAIN.Macro.MsgBox("実行します","OKCANCEL") == true)
{
      (メソッド呼び出しetc)
}
alert("終了しました");

■Paste

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

クリップボード内容を現在のカーソル位置へ貼り付けます。


●呼び出し形式

Paste()

●パラメータ

ありません


●リターン値

キー入力禁止状態の場合、または異常終了の場合にFALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.CopyLn(1, 1, 1, 80);
F5AAUIMAIN.Macro.SetCursorPos(2, 1);
F5AAUIMAIN.Macro.Paste();             // 1行目をコピーし、2行目に貼り付け

■Scan

画面上の文字列を検索

画面上の指定範囲に指定の文字列があるかどうかを検索します。


●呼び出し形式

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

●パラメータ

パラメータ

説明

省略時の初期値

Text

検索する文字列

省略できません

Row1

検索開始行位置（1～24）

1

Col1

検索開始桁位置（1～80）

1

Row2

検索終了行位置（1～24）

24

Col2

検索終了桁位置（1～80）

80


●リターン値

検索する文字列の長さが0の場合、または画面上に文字列が見つかった場合、TRUEを返します。画面上に文字列が見つからなかった場合、または異常終了の場合、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

if(F5AAUIMAIN.Macro.Scan("TSSX") == true)
    alert("ログオンが完了しました");
else
    alert("ログオンは完了していません");

■SetCursorPos

カーソル位置の設定

カーソル位置を指定位置へ移動します。


●呼び出し形式

SetCursorPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

カーソル行（1～24）

省略できません

Col

カーソル桁（1～80）

省略できません


●リターン値

キー入力禁止状態の場合、または異常終了の場合、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.SetCursorPos(1, 1);  // 1行1桁目にカーソルを移動

■SetKeyUnlockTime

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

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


●呼び出し形式

SetKeyUnlockTime(Second)

●パラメータ

パラメータ

説明

省略時の初期値

Second

キーアンロックタイム（秒）（0～65535）
0の場合は待ち合わせません

省略できません


●リターン値

関数の呼び出しに成功するとTRUEを返します。設定に失敗した場合、または異常終了の場合、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.SetKeyUnlockTime(2);  // キーアンロックタイムを2秒に設定

■SetWaitTime

最大待ち時間の設定

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


●呼び出し形式

SetWaitTime(Second)

●パラメータ

パラメータ

説明

省略時の初期値

Second

待ち時間（秒）（1～65535）

省略できません


●リターン値

関数の呼び出しに成功するとTRUEを返します。設定に失敗した場合、または異常終了の場合、FALSE「設定失敗」を返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.SetWaitTime(2);  // 最大待ち時間を2秒に設定

■Sleep

指定時間実行を停止

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


●呼び出し形式

Sleep(Second)

●パラメータ

パラメータ

説明

省略時の初期値

Second

停止時間（秒）

省略できません


●リターン値

関数の呼び出しに成功するとTRUEを返します。停止に失敗した場合、または異常終了の場合、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。
このメソッドで停止するのは、スクリプトの処理であり、ホストとのやり取りは停止しません。したがって、停止中でも画面データ等の更新は行われます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.Sleep(2);  // 2秒間停止する

■Start

セッションの接続

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


●呼び出し形式

Start(PathName)

●パラメータ

パラメータ

説明

省略時の初期値

PathName

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

省略できません


●リターン値

関数の呼び出しに成功するとTRUEを返します。接続パスがすでに起動している場合、ホストと接続に失敗した場合、または異常終了の場合は、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。接続に成功した場合、アクティブセッションが接続パスに切り替わった時点で、このメソッドは復帰します。


●JavaScriptを用いて記述した例

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

■Stop

セッションの切断

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


●呼び出し形式

Stop()

●パラメータ

ありません


●リターン値

関数の呼び出しに成功するとTRUEを返します。すでにセッションが切断されている場合、セッションの切断が中断された場合、または異常終了の場合は、復帰値にFALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.Stop();  // アクティブセッションを終了する

■Type

キー入力

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


●呼び出し形式

Type(Text, Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Text

入力する文字列

省略できません

Row

入力開始行位置（1～24）

カーソル位置

Col

入力開始桁位置（1～80）

カーソル位置


●リターン値

関数の呼び出しに成功するとTRUEを返します。入力禁止フィールドにキー入力を行おうとしたり、キー入力処理中に入力禁止状態になった場合、また異常終了の場合に、FALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.Type("LOGON TSS[ENTER]");  // 文字列 + 実行キー
F5AAUIMAIN.Macro.Type("[41A1][41A2]");      // JEFコード入力

●特殊キーの指定一覧

機能

記述形式

機能

記述形式

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]


■TypeKey

キーの1文字即時入力

1文字分のキー入力をエミュレーションします。キーボードロック状態の場合は入力失敗で復帰します。Typeメソッドと違いキー入力可能になるのを待ちません。
入力キーにはTypeメソッドと同様の形式で特殊キーやJEFコードの指定が可能です。ただし、1文字分のキーの指定のみ可能です。特殊キーの記述形式は、Typeメソッド関数を参照してください。


●呼び出し形式

TypeKey(Text)

●パラメータ

パラメータ

説明

省略時の初期値

Text

入力する文字

省略できません


●リターン値

関数の呼び出しに成功するとTRUEを返します。キーボードロック状態の場合、または異常終了の場合はFALSEを返します。エラーの詳細は、GetErrorメソッドにより取得できます。引数のTextには、文字列が指定可能であるが、最初の1文字が入力されます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.TypeKey("[RESET]");    // 特殊文字
F5AAUIMAIN.Macro.TypeKey("[41A1]");     // JEFコード入力

■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を返します。エラーの詳細は、GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

F5AAUIMAIN.Macro.Wait("SYSTEM READY", 1, 1);  //「SYSTEM READY」の受信を待つ
F5AAUIMAIN.Macro.Wait();                        // キー入力可能になるのを待つ
前次
Copyright 2012 FUJITSU LIMITED