ページの先頭行へ戻る
WSMGR for Web V7.2 使用手引書L20
第7部 マクロ編 > 第23章 スクリプト（HTMLモード） > 23.4 WsmgrDspemuリファレンス > 23.4.7 macroオブジェクト
前次

23.4.7 macroオブジェクト

エミュレータの操作、およびエミュレータ画面のフィールド情報を参照するためのオブジェクトです。

メソッド名

機能

Javascritp

VB/C#

Activate

同左

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

Bye

〃

エミュレータの終了

ChangeProfile

〃

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

ChangeSessionProperty

〃

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

CmpText

〃

画面上の文字列と比較

CopyField

〃

フィールドデータの記憶

CopyLn

〃

行範囲データの記憶

CopyRc

〃

矩形範囲データの記憶

CopyScreen

〃

全画面範囲データの記憶

EnableKeyboard

-

キー入力の許可・禁止

ExecMacro

同左

マクロの実行

GetPrivateValue

〃

マクロ変数の取得

IsConnected

〃

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

IsKeyboardLock

〃

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

IsProtectPos

〃

入力禁止位置の確認

IsFieldTopPos

〃

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

IsFieldEndPos

〃

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

IsNumField

〃

数字フィールドの確認

MsgBox

-

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

Paste

同左

複写データの貼り付け

Scan

〃

画面上の文字列を検索

SetCursorPos

〃

カーソル位置の設定

SetKeyUnlockTime

〃

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

SetPrivateValue

〃

マクロ変数の設定

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)

省略できません


●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■Bye

エミュレータの終了

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


●呼び出し形式

Bye()

●パラメータ

ありません


●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■ChangeProfile

プロフィルの変更

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


●呼び出し形式

ChangeProfile(ProfileKind, ProfileName)

●パラメータ

パラメータ

説明

省略時の初期値

ProfileKind

変更するプロファイル
(DSPPROFILE)

省略できません

ProfileName

変更するプロファイル名

省略できません


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■ChangeSessionProperty

接続先相手名/IPアドレス、LU名、ポート番号の変更

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


●呼び出し形式

ChangeSessionProperty(PathName, PropName, Propvalue)

●パラメータ

パラメータ

説明

省略時の初期値

PathName

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

省略できません

PropName

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

  1. 接続先相手名/IPアドレス
    (TnServerAddress)

  2. LU名(TnLuName)

  3. ポート番号(TnPortNum)

省略できません

Propvalue

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

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

  2. LU名

  3. 0～65535

省略できません


LU名を削除する場合は空文字("")を設定してください


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

// セッション１の接続先相手名/IPアドレスを192.1.1.1に変更する。
dspemu.macro.ChangeSessionProperty("DSP1", "TnServerAddress", "192.1.1.1");

注意

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


■CmpText

画面上の文字列と比較

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


●呼び出し形式

CmpText(Text, Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Text

比較する文字列

省略できません

Row

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

カーソル位置

Col

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

カーソル位置


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■CopyField

フィールドデータの記憶

指定位置のフィールド内範囲のデータを記憶します。記憶したデータはPasteメソッドを使用してエミュレータ画面へ貼り付けが可能です。


●呼び出し形式

CopyField(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

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

カーソル位置

Col

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

カーソル位置


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.CopyField(1, 40);// 1行目、40桁の位置のフィールド内範囲を記憶

注意

本メソッドを使用して記憶したデータはエミュレータ画面内でのみ使用することができます。


■CopyLn

行範囲データの記憶

指定位置で囲まれる行範囲のデータを記憶します。記憶したデータはPasteメソッドを使用してエミュレータ画面に貼り付けが可能です。


●呼び出し形式

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.CopyLn(1, 1, 1, 80);  // 1行目を1桁から80桁までを記憶

注意

本メソッドを使用して記憶したデータはエミュレータ画面内でのみ使用することができます。


■CopyRc

矩形範囲データの記憶

指定位置で囲まれる矩形範囲のデータを記憶します。記憶したデータはPasteメソッドを使用してエミュレータ画面に貼り付けが可能です。


●呼び出し形式

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.CopyRc(1, 1, 3, 80);  // 1行目を1桁から3行目80桁までを記憶

注意

本メソッドを使用して記憶したデータはエミュレータ画面内でのみ使用することができます。


■CopyScreen

全画面範囲データの記憶

全画面範囲のデータを記憶します。記憶したデータはPasteメソッドを使用してエミュレータ画面に貼り付けが可能です。


●呼び出し形式

CopyScreen()

●パラメータ

ありません


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.CopyScreen();  // 全画面を記憶

注意

本メソッドを使用して記憶したデータはエミュレータ画面内でのみ使用することができます。


■EnableKeyboard

キー入力の抑止と許可

キー入力の一時的な抑止や許可を行います。


●呼び出し形式

EnableKeyboard(bEnable, keyList)

●パラメータ

パラメータ

説明

省略時の初期値

bEnable

true：キー入力許可
false：キー入力抑止

省略できません

keyList

bEnableで入力を操作するキーを指定

すべてのキー


●キーの指定一覧

プログラム・アテンションキー

機能

記述形式

機能

記述形式

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]


機能拡張キー

機能

記述形式

機能

記述形式

JEF16進入力

[HEX]

フルスクリーン切替え

[FULLSCREEN]

コピー

[EDITCOPY]

URLを開く

[URLSELECT]

貼り付け

[EDITPASTE]

範囲選択(←)

[EDITLEFT]

すべて選択

[EDITSELECTALL]

範囲選択(→)

[EDITRIGHT]

表示カラー変更

[COLOR]

範囲選択(↑)

[EDITUP]

エミュレータ終了

[EXIT]

範囲選択(↓)

[EDITDOWN]

強制終了

[ABORT]

セッション切替え(次)

[LUCHGFORWARD]

マクロ記録

[MACROREC]

セッション切替え(前)

[LUCHGBACK]

マクロ実行

[MACROEXEC]

セッション切替え(ディスプレイ1)

[LUCHGDSP1]

マクロをもう一度実行

[MACROREPEAT]

セッション切替え(ディスプレイ2)

[LUCHGDSP2]

マクロ設定

[MACROEDIT]

セッション切替え(ディスプレイ3)

[LUCHGDSP3]

マウス
(編集モード)

[MOUSEEDIT]

セッション切替え(ディスプレイ4)

[LUCHGDSP4]

マウス
(ライトペン)

[MOUSELPEN]

画面情報一時保存(BMP)

[DSPINFBMP]

マウス
(不使用)

[MOUSEOFF]

画面情報一時保存(TXT)

[DSPINFTXT]


参考

keyListを指定せずにbEnableにfalseを指定した場合、以下のキーは入力可能です。
・RESET
・ATTN
・SYSREQ


●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。エラーの詳細は、getErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

if (dspemu.screen.findField("業務メニュー") != null) {
    dspemu.macro.EnableKeyboard(false, ["[PF17]", "[PF18]", "[EDITCOPY]"]);  // PF17、PF18、コピーキーの入力を抑止
} else {
    dspemu.macro.EnableKeyboard(true, ["[PF1]", "[PF2]", "[EDITPASTE]"]);  // PF1、PF2、ペーストキーの入力を許可
}

■ExecMacro

マクロの実行

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


●呼び出し形式(JavaScript)

ExecMacro(MacroName, Callback)

●呼び出し形式(VB/C#)

ExecMacro(MacroName)

●パラメータ

パラメータ

説明

省略時の初期値

MacroName

実行するマクロファイル名

省略できません

Callback

マクロ実行後に呼び出されるコールバック関数を指定
クライアントスクリプトで利用時のみ指定可能

コールバック関数なし

注意

コールバック関数はエミュレータと同一ウィンドウから指定してください。


●リターン値

関数の成否に関わらずtrueを返します。
クライアントスクリプト(JavaScript)のExecMacroメソッドは非同期で実行されるためマクロの実行完了を待ち合わせずに復帰します。マクロの実行完了を待ち合わせて処理を行う場合は、コールバック関数を指定して関数内で処理してください。
サーバスクリプト（VB/C#）のExecMacroメソッドは同期で実行されるためマクロ実行の終了、または中断により復帰します。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.ExecMacro("macro1.scr", function () { 
    // マクロ実行後の処理を記述
});

■GetPrivateValue

マクロ変数の取得

マクロ実行時に設定したエミュレータセッションで有効なマクロ変数値を取得します。


●呼び出し形式

GetPrivateValue(varName)

●パラメータ

パラメータ

説明

省略時の初期値

varName

マクロ変数名

省略できません


●リターン値

関数の呼び出しに成功するとマクロ変数に登録した値を返します。エラーが発生した場合はnullを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.ExecMacro("macro1.scr", function(){
    dspemu.macro.GetPrivateValue("result"); // マクロ変数「result」の値を取得
});

■IsConnected

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

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


●呼び出し形式

IsConnected()

●パラメータ

ありません


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

if (dspemu.macro.IsConnected() == true)
    dspemu.macro.MsgBox("接続状態です");
else
    dspemu.macro.MsgBox("未接続状態です");

■IsFieldEndPos

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

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


●呼び出し形式

IsFieldEndPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

確認行位置（1～24）

カーソル位置

Col

確認桁位置（1～80）

カーソル位置


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

if (dspemu.macro.IsFieldEndPos() == true)
    dspemu.macro.MsgBox("フィールドの最終位置です");

■IsFieldTopPos

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

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


●呼び出し形式

IsFieldTopPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

確認行位置（1～24）

カーソル位置

Col

確認桁位置（1～80）

カーソル位置


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■IsKeyboardLock

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

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


●呼び出し形式

IsKeyboardLock()

●パラメータ

ありません


●リターン値

関数を呼び出した時にキー入力禁止の場合はtrueを返します。キー入力可能の場合またはエラーが発生した場合は、falseを返します。エラー詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

if (dspemu.macro.IsKeyboardLock() == true)
    dspemu.macro.MsgBox("キー入力できない状態です");

■IsNumField

数字フィールドの確認

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


●呼び出し形式

IsNumField(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

確認行位置（1～24）

カーソル位置

Col

確認桁位置（1～80）

カーソル位置


●リターン値

関数を呼び出した時に指定位置のフィールドが数字フィールドの場合はtrueを返します。数字フィールドでない場合、またはエラーが発生した場合、falseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

if (dspemu.macro.IsNumField() == true)
    dspemu.macro.MsgBox("数字フィールド位置です");

■IsProtectPos

入力禁止位置の確認

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


●呼び出し形式

IsProtectPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

確認行位置（1～24）

カーソル位置

Col

確認桁位置（1～80）

カーソル位置


●リターン値

関数を呼び出した時に指定位置がキー入力禁止位置の場合はtrueを返します。キー入力可能位置の場合、またはエラーが発生した場合は、falseを返します。エラー詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■MsgBox

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

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


●呼び出し形式

MsgBox(Text, Style)

●パラメータ

パラメータ

説明

省略時の初期値

Text

表示する文字列

省略できません

Style

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

OKモードになります


●リターン値

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

モード

押されたボタン

復帰値

OK

[OK]

true

OKCANCEL

[OK]

true

[キャンセル]

false

YESNO

[OK]

true

[キャンセル]

false


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

if (dspemu.macro.MsgBox("実行します", "OKCANCEL") == true) {
    // メソッド呼び出し、など
}
dspemu.macro.MsgBox("終了しました");

■Paste

複写データの貼り付け

CopyField、CopyLn、CopyRc、CopyScreenの各メソッドで複写したデータを現在のカーソル位置へ貼り付けます。


●呼び出し形式

Paste()

●パラメータ

ありません


●リターン値

キー入力禁止状態の場合、またはエラーが発生した場合にfalseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.CopyLn(1, 1, 1, 80);
dspemu.macro.SetCursorPos(2, 1);
dspemu.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／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■SetCursorPos

カーソル位置の設定

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


●呼び出し形式

SetCursorPos(Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Row

カーソル行（1～24）

省略できません

Col

カーソル桁（1～80）

省略できません


●リターン値

キー入力禁止状態の場合、またはエラーが発生した場合、falseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■SetKeyUnlockTime

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

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


●呼び出し形式

SetKeyUnlockTime(Second, MilliSecond)

●パラメータ

パラメータ

説明

省略時の初期値

Second

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

省略できません

MilliSecond

キーアンロックタイム(ミリ秒)
Secondで指定した秒に加算します。

0


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.SetKeyUnlockTime(2, 500);  // キーアンロックタイムを2.5秒に設定

■SetPrivateValue

マクロ変数への値の設定

マクロ実行時にエミュレータセッションで有効なマクロ変数に値を設定します。


●呼び出し形式

SetPrivateValue(varName, value)

●パラメータ

パラメータ

説明

省略時の初期値

varName

マクロ変数名

省略できません

value

任意のデータ

省略できません


●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.SetPrivateValue("data", "value"); // マクロ変数「data」に値を設定

■SetWaitTime

最大待ち時間の設定

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


●呼び出し形式

SetWaitTime(Second)

●パラメータ

パラメータ

説明

省略時の初期値

Second

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

省略できません


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■Sleep

指定時間実行を停止

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


●呼び出し形式

Sleep(Second)

●パラメータ

パラメータ

説明

省略時の初期値

Second

停止時間（秒）

省略できません


●リターン値

関数の呼び出しに成功するとtrueを返します。停止に失敗した場合、falseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.Sleep(2);  // 2秒間停止する

■Start

セッションの接続

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


●呼び出し形式

Start(PathName)

●パラメータ

パラメータ

説明

省略時の初期値

PathName

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

省略できません


●リターン値

関数の呼び出しに成功するとtrueを返します。接続パスがすでに起動している場合、ホストと接続に失敗した場合、falseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■Stop

セッションの切断

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


●呼び出し形式

Stop()

●パラメータ

ありません


●リターン値

関数の呼び出しに成功するとtrueを返します。すでにセッションが切断されている場合、セッションの切断が中断された場合、falseを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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

■Type

キー入力

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

注意

1つのType文のパラメータで指定できる特殊キーは、1つのみです。2つ以上の特殊キーを指定しないでください。


●呼び出し形式

Type(Text, Row, Col)

●パラメータ

パラメータ

説明

省略時の初期値

Text

入力する文字列

省略できません

Row

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

カーソル位置

Col

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

カーソル位置


●リターン値

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


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.Type("LOGON TSS[ENTER]");  // 文字列 + 実行キー
dspemu.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／GetErrorメソッドにより取得できます。引数のTextには、文字列が指定可能であるが、最初の1文字が入力されます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.macro.TypeKey("[RESET]");    // 特殊文字
dspemu.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／GetErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

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