34.3.1 サーバAPIの概要

エミュレータセッションの起動、終了、およびWSMGR for Webのマクロ相当機能をAPIとして利用できます。VB/C#で記述したサーバアプリケーションからDSPEMUを操作することができます。

サーバAPI機能

セッションの起動、終了
WSMGR for Webのマクロ相当の機能
WSMGR for Webのマクロの呼び出し

スクリプトのオブジェクト階層

スクリプトのオブジェクトは次のような階層で構成されます。サーバアプリケーションからエミュレータを操作するためのオブジェクトをサポートします。エミュレータ画面にとらわれない自由な画面を作成することができます。

呼び出し形式

サーバAPIは、WSMGR for Webがインストールされているサーバ上で、.NET Framework用のVBまたはC#から使用することが可能なメソッドです。制御文などは.NET Frameworkの言語仕様に基づいて処理を記述することができます。
C#から実行する場合の呼び出し方法を以下に示します。

// 初期化
WsmgrConnectInfo info = new WsmgrConnectInfo();
info.User = "user1";
info.Pw = "pw1";
info.Icon = "接続1";
info.Init();

// オブジェクトの生成
WsmgrDspemu dspemu = new WsmgrDspemu(info);

// Typeメソッドの呼び出し
dspemu.Macro.Type("LOGON [ENTER]");

// 終了
info.Uninit();

エミュレータが起動済みで、クライアントスクリプトのforwardメソッド経由でサーバAPIを実行する場合は、以下のように記述することができます。

// オブジェクトの生成
WsmgrDspemu dspemu = new WsmgrDspemu(Context);

// Typeメソッドの呼び出し
dspemu.Macro.Type("LOGON [ENTER]");

// 終了
dspemu.Macro.Bye();

ポイント

オブジェクトやメソッドの命名規約はそれぞれの実行環境で一般的な命名規約を採用しています。.NET環境ではPascalCaseを採用しています。WSMGR for Webの旧バージョンから存在する関数は一部例外があります。

注意

サーバAPI機能はオペレータの入力軽減が目的であり、無人で自動実行させるものではありません。
正常に動作しない場合にオペレータが復旧できる範囲で使用してください。