WSMGR for Web V9 使用手引書

34.3.6 WsmgrDspemuオブジェクト

エミュレータ操作をスクリプトで行うための基底オブジェクトです。WsmgrDspemuの各オブジェクトで使用可能なメソッドとプロパティの一覧を示します。 各メソッドの中には、引数が必要なもの、引数が省略された時にデフォルト動作をするものがあります。

オブジェクト名	機能
Session	エミュレータセッションの操作、およびセッションの状態を取得するためのオブジェクトです。
Screen	エミュレータの画面よりFieldオブジェクトやカーソル位置などの情報を取得するためのオブジェクトです。
Macro	エミュレータの操作を行うためのオブジェクトです。
Field	エミュレータ画面上のフィールド情報を参照・操作するためのオブジェクトです。本オブジェクトはScreenオブジェクトのFindFieldメソッドによる取得が必要です。
Document	エミュレータ画面を示すドキュメントオブジェクトです。
FileTrans	ファイル転送を実行するためのオブジェクトです。
Trace	スクリプトログに任意の文字列を出力するためのオブジェクトです。
Util	スクリプト機能のユーティリティオブジェクトです。

メソッド名	機能
Addr	行、桁位置のエミュレータ画面アドレスへの変換
Col	エミュレータ画面アドレスの桁位置への変換
GetError	エラー番号の取得
GetIconName	接続アイコン名を取得
GetInputStatus	入力禁止状態の取得
GetUserName	認証中のユーザ名を取得
GetUserString	登録文字列の取得
Row	エミュレータ画面アドレスの行位置への変換

■Addr

行、桁位置のエミュレータ画面アドレスへの変換

パラメータで指定した行、桁位置をエミュレータ画面上のアドレス位置に変換します。

●呼び出し形式

Addr(row, col)

●パラメータ

パラメータ	説明	省略時の初期値
row	行位置（1～24）	省略できません
col	桁位置（1～80）	省略できません

●リターン値

関数の呼び出しに成功するとエミュレータ画面上のアドレス位置を、0～1919の範囲で返します。パラメータの指定に誤りがあった場合は-1を返します。

●C#を用いて記述した例

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

var dspaddr = dspemu.Addr(24, 80);  // 24行、80桁を画面アドレスに変換

■ Col

エミュレータ画面アドレスの桁位置への変換

パラメータで指定したエミュレータ画面上のアドレス位置を桁位置に変換します。

●呼び出し形式

Col(address)

●パラメータ

パラメータ	説明	省略時の初期値
address	エミュレータ画面上のアドレス（0～1919）	省略できません

●リターン値

関数の呼び出しに成功すると桁位置を、1～80の範囲で返します。パラメータの指定に誤りがあった場合は-1を返します。

●C#を用いて記述した例

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

var dspcol = dspemu.Col(1919);  // 画面アドレス（1919）を桁位置に変換

■GetError

エラー番号の取得

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

●呼び出し形式

GetError()

●パラメータ

ありません

●リターン値

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

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

復帰値	復帰値の意味
0	エラーはありません。
1	パラメータが不正です。
2	メモリ不足が発生しました。
4	Typeメソッドで無効なキーが指定されました。
12	セッションが異常終了しました。
13	タイムアウトが発生しました。
18	ホストと接続されていません。
22	文字列が見つかりませんでした。
23	キー入力禁止でした。
24	未サポート関数が呼び出されました。
25	Startメソッドでセッションが起動できませんでした。
26	Stopメソッドでセッションが終了できませんでした。
27	セッションが未起動です。
28	キー入力禁止を解除しました。
50	スクリプト実行中につき実行できません。
51	プロパティの変更に失敗しました。
52	プロファイルの変更に失敗しました。
70	すでにデータベース接続が開始されています。
71	データベース接続が開始されていません。
72	トランザクションの開始でエラーが発生しました。
73	SQL文の実行でエラーが発生しました。
74	トランザクションが開始されていません。
75	トランザクションのコミットでエラーが発生しました。
76	トランザクションのロールバックでエラーが発生しました。
77	トランザクションタイムアウトが発生しました。
90	ライセンス数が不足しています。
91	APIサポートがインストールされていません。
100	致命的エラー(内部エラー、 複写失敗)です。

●C#を用いて記述した例

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

var errcode = dspemu.GetError();

■GetIconName

接続アイコン名の取得

現在起動しているエミュレータの接続アイコン名を取得します。

●呼び出し形式

GetIconName()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると接続アイコン名を返します。エミュレータが起動していない場合はnullを返します。

●C#を用いて記述した例

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

var icon = dspemu.GetIconName(); // アイコン名の取得

■GetInputStatus

入力禁止状態の取得

エミュレータの入力禁止状態を取得します。

●呼び出し形式

GetInputStatus()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとエミュレータの入力禁止状態値を返します。エラーが発生した場合は-1を返します。

●入力禁止状態

状態	状態表示行の表示		値
	6680	3270
キー入力可			0
キーボードロック ※RESETキーで解除不可	処理中		1
	キーボードロック	SYSTEM	2
不正入力 ※RESETキーで解除可	無効な入力です	？＋	3
	無効な機能です	－f	4
	フィールドオーバー	＞	5
	入力不可能位置		6
	-	－s	7
	数字のみ入力可能	NUM	8
	全桁入力して下さい	-	9
	入力もれがあります	-	10
	入力誤りです	-	11
	指定誤りです	-	12

●C#を用いて記述した例

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

if (dspemu.Macro.Type('LOGON TSS[ENTER]')) {

    // 入力禁止状態の確認

    if (dspemu.GetInputStatus() != 0) {

        // 入力禁止状態時の処理

    }

} 

■GetUserName

ユーザ名の取得

エミュレータを起動しているユーザ名を取得します。

●呼び出し形式

GetUserName()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとユーザ名を返します。エミュレータが起動していない場合はnullを返します。

●C#を用いて記述した例

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

var user = dspemu.GetUserName(); // ユーザ名の取得

■GetUserString

登録文字列の取得

あらかじめ登録したリソースファイルの内容から、指定したキーに設定済みの文字列を取得します。リソースファイルに任意の文字列を登録しておくことで、スクリプトでその文字列を動的に取得して使用することができます。

●呼び出し形式

GetUserString(key)

●パラメータ

パラメータ	説明	省略時の初期値
key	リソースファイルより取得する文字列を設定したキー名の文字列	省略できません

●リソースファイル

本メソッドにより参照するリソースファイルはCSV形式の固定名のファイルです。ファイルごとに用途と登録場所が異なります。

ファイル名	用途	ファイルの登録場所
WsmgrUserData.csv	WSMGR for Webのユーザが利用できる定数を登録します	<WSMGR for Webインストールフォルダ>\config\users
WsmgrGroupData.csv	WSMGR for Webのグループが利用できる定数を登録します	<WSMGR for Webインストールフォルダ>\config\group\<グループ名>
WsmgrSystemData.csv	WSMGR for Webのシステムで共通に利用できる定数を登録します	<WSMGR for Webインストールフォルダ>\config\common

注意

「WsmgrGroupData.csv」はグループごとのフォルダに登録してください。

各リソースファイルはWSMGR for Webへの認証情報を基に次のリソース検索ルールに従って順番に参照され、最初に見つかった指定キーの値を返します。

設定値	説明
ユーザ（グループ）のみ	ユーザに定義された接続アイコンで起動されたエミュレータはユーザのリソースのみ使用します。グループに定義された接続アイコンで起動されたエミュレータはグループのリソースのみ使用します。
ユーザ＞グループ＞共通の順番に検索	ユーザ、グループ、共通の順番にリソースを検索します。同名のリソースがある場合はユーザ、グループの順に優先されます。
共通＞グループ＞ユーザの順番に検索	共通、グループ、ユーザの順番にリソースを検索します。同名のリソースがある場合は共通、グループの順に優先されます。

参考

リソース検索ルールの設定は、管理ツールより［ユーザ・グループ設定］の［共通プロパティの設定］にて行います。詳細は「8.2.5 ユーザ制限とプロファイル、リソースの検索ルールの設定」の「■プロファイル、リソースの検索ルール」を参照してください。

リソースファイルの各項目はカンマで区切ってください。キー名と値の文字列は自由に指定できます。
フォーマットは次のとおりです。

• WsmgrUserData.csv

  1行目はヘッダ行として扱い、1列目にユーザ名の列を示す定数「UserName」、2列目以降にはキーを指定します。2行目以降は1行目の項目に対応した設定値を同じ列に指定します。1列目にWSMGR for Webのユーザ名、2列目以降にキーに設定する値を指定します。
  ユーザを追加する場合は行を追加、キーと値を追加する場合は列を追加してください。

  	1列目	2列目以降
  1行目	UserName	キー
  2行目以降	ユーザ名	値

  設定例）

  UserName,ユーザID,パスワード,部門,役職,内線番号
  wsmgr-user1,ID0001,PW0001,営業,部長,2010-2111
  wsmgr-user2,ID0002,PW0002,営業,,2011-2222
  wsmgr-user3,ID0003,PW0003,営業,課長,2012-2333
  wsmgr-user3,ID0003,PW0003,営業,,2012-2444

• WsmgrGroupData.csv/WsmgrSystemData.csv

  1行目はキーを指定し、2行目には1行目に対応するキーの値を設定します。キーと値を追加する場合は列を追加してください。

  	1列目	2列目以降
  1行目	キー	キー
  2行目	値	値

  設定例）

  ログオン文字列,WSMGR for WebサーバのURL,ホスト画面ID,
  LOGON TSS,http://exsample.com/wsmgrweb/,HOST001,

  
  

●リターン値

関数の呼び出しに成功すると指定したキーに設定した文字列を返します。文字列が取得できなかった場合やエラーが発生した場合はnullを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。

●C#を用いて記述した例

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

var LogonID = dspemu.GetUserString("ログオンID");

■Row

エミュレータ画面アドレスの行位置への変換

パラメータで指定したエミュレータ画面上のアドレス位置を行位置に変換します。

●呼び出し形式

Row(address)

●パラメータ

パラメータ	説明	省略時の初期値
address	エミュレータ画面上のアドレス（0～1919）	省略できません

●リターン値

関数の呼び出しに成功すると行位置を、1～24の範囲で返します。パラメータの指定に誤りがあった場合は-1を返します。

●C#を用いて記述した例

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

var dsprow = dspemu.Row(1919);  // 画面アドレス（1919）を行位置に変換