34.3.7 Sessionオブジェクト

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

メソッド名	機能
Activate	指定されたセッションに切り替え
ChangeSessionProperty	接続先相手名/IPアドレス、LU名、ポート番号、端末タイプの変更
GetSessionProperty	接続先相手名/IPアドレス、LU名、ポート番号、端末タイプの取得
Connect	セッションの接続
Disconnect	セッションの切断
GetProfile	プロファイル名の取得
IsConnected	指定されたセッションの接続状態を確認
SetProfile	プロファイルの変更

注意

サーバAPIではプリンタセッションの制御は未サポートです。

■Activate

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

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

●呼び出し形式

Activate(sessionNum)

●パラメータ

パラメータ	説明	省略時の初期値
sessionNum	ディスプレイ：1～4の範囲で指定プリンタ：5を指定	省略できません

●リターン値

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

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

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

// セッション1～3を接続
dspemu.Session.Connect(1);
dspemu.Session.Connect(2);
dspemu.Session.Connect(3);

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

■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メソッドにより取得できます。

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

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

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

注意

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

■GetSessionProperty

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

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

●呼び出し形式

GetSessionProperty(sessionNum, name)

●パラメータ

パラメータ	説明		省略時の初期値
sessionNum	セッション番号を1～4の範囲で指定		省略できません
name	設定するプロパティを示す文字列		省略できません
	"TnServerAddress"	接続先相手名/IPアドレス
	"TnLuName"	LU名
	"TnPortNum"	ポート番号
	"TnTerminalType"	端末タイプ

●リターン値

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

エラーの詳細は、GetErrorメソッドにより取得できます。

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

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

int portNum = -1;
string serverAddress = null;
object rtn = dspemu.Session.GetSessionProperty(1, "TnPortNum");  // ポート番号を取得
if (rtn is int)
{
    int value = (int)rtn;
    if (value >= 0)
    {
        portNum = value;
    }
}
rtn = dspemu.Session.GetSessionProperty(1, "TnServerAddress");  // 接続先IPアドレスを取得
if (rtn is string)
{
    serverAddress = rtn as string;
}

■Connect

セッションの接続

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

●呼び出し形式

Connect(sessionNum)

●パラメータ

パラメータ

説明

省略時の初期値

sessionNum

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

プリンタ：5を指定

省略できません

●リターン値

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

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

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

dspemu.Session.Connect(1); // セッション1を接続

■Disconnect

セッションの切断

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

●呼び出し形式

Disconnect()

●パラメータ

ありません

●リターン値

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

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

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

dspemu.Session.Connect(1); // セッション1を接続

dspemu.Session.Disconnect(); // セッションを終了

■GetProfile

プロファイル名の取得

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

●呼び出し形式

GetProfile()

●パラメータ

ありません

●リターン値

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

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

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

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

■IsConnected

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

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

●呼び出し形式

IsConnected(sessionNum)

●パラメータ

パラメータ	説明	省略時の初期値
sessionNum	ディスプレイ：1～4の範囲で指定プリンタ：5を指定	省略できません

●リターン値

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

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

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

dspemu.Session.Connect(1); // セッション1を接続

if (dspemu.Session.IsConnected(1)) 
{
    // DSP1は接続中です
}

■SetProfile

プロファイルの変更

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

●呼び出し形式

SetProfile(profileName)

●パラメータ

パラメータ	説明	省略時の初期値
profileName	変更するプロファイル名	省略できません

●リターン値

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

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

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

dspemu.Session.SetProfile("6680標準(Webスタイル)");  // プロファイルを"6680標準(Webスタイル)"へ変更