ページの先頭行へ戻る
WSMGR for Web V9 使用手引書
FUJITSU Software
第7部 マクロ編 > 第32章 スクリプト（HTMLモード） > 32.4 WsmgrDspemuリファレンス > 32.4.3 sessionオブジェクト
前次

32.4.3 sessionオブジェクト

エミュレータセッションの操作、およびセッションの状態を取得するためのオブジェクトです。

メソッド名

(JavaScript)

機能

activate

指定されたセッションに切り替え

bind

セッションイベントの登録

changeSessionProperty

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

connect

セッションの接続

disconnect

セッションの切断

getProfile

プロファイル名の取得

getSessionProperty

接続先相手名/IPアドレス、LU名、ポート番号、端末タイプの取得

isConnected

指定されたセッションの接続状態を確認

setProfile

プロファイルの変更

オブジェクト名

(JavaScript)

機能

初期値

event

イベントの発生時にbindメソッドで登録したコールバック関数に渡されるオブジェクト

-


注意

  • プリンタセッションをクライアントスクリプトで制御するためには、スクリプトが動作する環境にWSMGR for WebのIEアドオンが登録されている必要があります。
    IEアドオンの登録は、プリンタセッションが定義されている接続アイコンを起動することにより必要に応じて自動で行われます。スクリプトにより初めてプリンタセッションを制御する場合は、WSMGR for Webのログオン画面からログオンし、接続先の一覧からプリンタセッションが定義されているエミュレータを起動してください。

  • プリンタセッションを制御するためには、Internet Explorerを使用してください。


■activate

指定セッションへの切り替え

指定されたセッションへ切り替えます。


●呼び出し形式

activate(sessionNum)

●パラメータ

パラメータ

説明

省略時の初期値

sessionNum

ディスプレイ：1～4の範囲で指定
プリンタ：5を指定

省略できません


●リターン値

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


●JavaScriptを用いて記述した例

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

dspemu.session.activate(2); // セッション2へ切り替え

■bind

セッションイベントの登録

ディスプレイセッションで指定したイベントが発生した際に呼び出されるコールバック関数を登録します。


●呼び出し形式

bind(type, func)

●パラメータ

パラメータ

説明

省略時の初期値

type

コールバック関数を登録するイベント名を示す文字列

省略できません

"connect"

接続完了イベント

"disconnect"

切断完了イベント

"chageLu"

LU切替えイベント

"changeProfile"

プロファイル変更イベント

func

コールバック関数を指定
typeで指定したイベントに登録された関数を解除する場合は null を指定

null


●リターン値

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


●JavaScriptを用いて記述した例

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

dspemu.session.bind("connect", onConnect); // 接続完了イベント発生時の関数を登録

■changeSessionProperty

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

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


●呼び出し形式

changeSessionProperty(sessionNum, name, value)

●パラメータ

パラメータ

説明

省略時の初期値

sessionNum

セッション番号を1～4の範囲で指定

省略できません

name

設定するプロパティを示す文字列

省略できません

"TnServerAddress"

接続先相手名/IPアドレス

"TnLuName"

LU名

"TnPortNum"

ポート番号

"TnTerminalType"

端末タイプ

value

設定を変更するプロパティの値
・接続先相手名/IPアドレス
  (文字列またはアドレス値)
・LU名(文字列)
・0～65535(数値)

省略できません


●リターン値

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


●JavaScriptを用いて記述した例

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

dspemu.session.changeSessionProperty(1, "TnServerAddress", "192.1.1.1"); // 接続先IPアドレスを変更

注意

このメソッドは、管理ツールでプロパティの設定の変更を許可されたユーザのみ成功します。


■connect

セッションの接続

指定されたセッション番号のセッションを接続します。


●呼び出し形式

connect(sessionNum)

●パラメータ

パラメータ

説明

省略時の初期値

sessionNum

ディスプレイ：1～4の範囲で指定

プリンタ：5を指定

省略できません


●リターン値

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


●JavaScriptを用いて記述した例

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

dspemu.session.connect(1); // セッション1を接続

■disconnect

セッションの切断

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


●呼び出し形式

disconnect()

●パラメータ

ありません


●リターン値

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


●JavaScriptを用いて記述した例

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

dspemu.session.disconnect(); // セッションを終了

■getProfile

プロファイル名の取得

アクティブなセッションのプロファイル名を取得します。


●呼び出し形式

getProfile()

●パラメータ

ありません


●リターン値

関数の呼び出しに成功するとディスプレイプロファイル名を返します。エラーが発生した場合は、空文字を返します。エラーの詳細は、getErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

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

var profileName = dspemu.session.getProfile(); // プロファイル名を取得

■getSessionProperty

接続先相手名/IPアドレス、LU名、ポート番号、端末タイプの取得

セッション設定の接続先相手名/IPアドレス、LU名、ポート番号、端末タイプを取得します。


●呼び出し形式

getSessionProperty(sessionNum, name)

●パラメータ

パラメータ

説明

省略時の初期値

sessionNum

セッション番号を1～4の範囲で指定

省略できません

name

取得するプロパティを示す文字列

省略できません

"TnServerAddress"

接続先相手名/IPアドレス

"TnLuName"

LU名

"TnPortNum"

ポート番号

"TnTerminalType"

端末タイプ


●リターン値

関数の呼び出しに成功すると取得したセッション設定情報(ポート番号は数値、その他のプロパティは文字列)を返します。プロパティ取得に失敗した場合、ポート番号は-1、その他のプロパティはnullを返します。エラーの詳細は、getErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

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

dspemu.session.bind('connect', function (e) {

    // 接続先相手名/IPアドレスの取得
    var hostAddress = dspemu.session.getSessionProperty(e.luNum, 'TnServerAddress');

    // LU名の取得
    var luName = dspemu.session.getSessionProperty(e.luNum, 'TnLuName');
});

■isConnected

セッションの接続状態の確認

指定されたセッションが接続済みの状態であるかを確認します。


●呼び出し形式

isConnected(sessionNum)

●パラメータ

パラメータ

説明

省略時の初期値

sessionNum

ディスプレイ：1～4の範囲で指定
プリンタ：5を指定

省略できません


●リターン値

指定されたセッションが接続状態の場合はtrueを返します。指定したセッションが未接続の場合はfalseを返します。


●JavaScriptを用いて記述した例

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

if (dspemu.session.isConnected(1)) {
    dspemu.macro.MsgBox("DSP1は接続中です。");
}

■setProfile

プロファイルの変更

アクティブなセッションのプロファイルを指定されたプロファイルに変更します。


●呼び出し形式

setProfile(profileName)

●パラメータ

パラメータ

説明

省略時の初期値

profileName

変更するプロファイル名

省略できません


●リターン値

関数の呼び出しに成功した場合、または変更前・変更後のプロファイルが同一の場合はtrueを返します。エラーが発生した場合は、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。


●JavaScriptを用いて記述した例

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

dspemu.session.setProfile("6680標準(Webスタイル)");  // プロファイルを"6680標準(Webスタイル)"へ変更
前次
Copyright 2022 FUJITSU LIMITED