セッション・マネージャー API
機能要求
Session Manager API 文書は、JavaScript を使用して Web ページにホストセッションを埋め込むために Z and I Web 用 (ZIEWeb) が提供するSession Manager API について説明します。
簡単な説明:
ホストアクセスツールキットで提供されるアプリケーションプログラミングインターフェース (API) に加えて、Z and I Web (ZIEWeb) エミュレーターは、Session Manager API と呼ばれる特別なパブリック API も提供します。 これらは、JavaScript を使用して Web ページにホストセッションを埋め込むためのサポートを提供します。これらの JavaScript ベースの API は、アプリケーション開発者がホストセッションとホストセッションとのテキストベースの相互作用を管理するのに役立ちます。API は、Z and I Web 版 (ZIEWeb) セッションマネージャーを介して使用できます。
API は以下の 4 つのセットに分けられます。
•Session Manager API
• Presenter スペース API
• Z および I Web (ZIEWeb) 関数 API 用のエミュレータ
• エラーレポート API
セッションマネージャ API は、セッションの開始、停止、接続、切断、表示の機能を提供します。さらに、アクティブなセッション ID を取得する get メソッドも提供されています。セッションマネージャ API は、複数セッションだけでなく、セッションの複数インスタンスの管理をサポートします。
API の機能と文書:
• 関数 startSession (ストリングセッション)
startSession メソッドは、指定されたセッションを開始します。セッションの最初のインスタンスだけでなく、セッションの別のインスタンスを開始することができます。ユーザーは、セッションに割り当てられたセッション ID を管理する必要があります。後でこのセッションを呼び出す場合は、セッション名パラメーターにセッション ID を指定する必要があります。例えば、最初のセッションが開始され、セッション名が「3270 ディスプレイ」の場合、それ以降の呼び出しのセッション名パラメーターは「3270 ディスプレイ - A」でなければなりません。これにより、完全セッション名と関連した表示スペースを正しくマッピングできます。
返品
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | セッション名が無効です |
| -2 | EXCEPTION_ERROR | 例外エラー |
• 関数 getSessionID ()
getSessionID メソッドは、startSession API を使用して開始された最後のセッションのセッション ID を返します。ユーザーは、このセッション ID をセッション名に連結して、アクティブセッションの完全な (名前+ID) セッション名を作成する必要があります。この新規セッション名は、以降のすべての API 呼び出しで使用する必要があります。JSHostOn要求アプレットは 1 つのセッション ID のみを保存します。そのため、完全なセッション名を保存したい場合は、2 番目の startSession メソッド呼び出しを発行する前に、この API を使用する必要があります。
パラメータ: なし。
戻り値: startSession API を使用して開始された最後のセッションのセッション ID。 startSession メソッドを使用してセッションが開始されていない場合は null。
• 関数 getAllSessionNames ()
getAllSessionNames メソッドは、すべてのアクティブセッション名のストリングを次の形式で返します。
セッション名+セッションID;セッション名+セッションID
例: 3270 ディスプレイ - A;5250 ディスプレイ - B
パラメータ: なし。
戻り値: すべてのアクティブセッションの完全セッション名の文字列。アクティブなセッションがない場合は null。例外エラーの場合は "-2"。
• 関数 stopSession ()
stopSession メソッドは、現在選択されているセッションを停止します。
パラメータ: なし。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数stopSession1 (ストリングセッション名)
stopSession メソッドのこの署名は、指定されたセッションを停止します。
パラメータ:
sessionName : 停止するセッションのフルネーム。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
• 関数 stopAllSessions ()
stopAllSessions メソッドは、アクティブなセッションをすべて停止します。
パラメータ: なし。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数 connectSession ()
connectSession メソッドは、現在選択されているセッションに接続します。
パラメータ: なし。
返品
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数 connectSession1 (ストリングセッション名)
指定したセッションに接続します。
パラメータ:
sessionName : 接続するセッションのフルネーム。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
• 関数 attachSession ()
disconnectSession メソッドは、現在選択されているセッションを切断します。
パラメータ: なし。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数 attachSession1 (ストリングセッション名)
attachSession メソッドのこの署名は、指定されたセッションを切断します。
パラメータ:
sessionName : 切断するセッションのフルネーム。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
• 関数 showSession ()
showSession メソッドは、現在選択されているセッションを表示します。
パラメータ: なし。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数 showSession1 (ストリングセッション名)
showSession メソッドのこの署名は、現在選択されているセッションを表示します。
パラメータ:
sessionName : 表示するセッションのフルネーム。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
• 関数 booleanisHODLoaded()
isHODLoaded メソッドは、Z と I の Web 用エミュレータ (ZIEWeb) アプレットがロードされているかどうかをチェックします。このメソッドの主な目的は、キャッシュ・クライアントユーザーが、JavaScript API 関数が呼び出される前に、Z アンドI Web 用エミュレーター (ZIEWeb) がロードされていることを確認することです。Z and I Web 版 (ZIEWeb) アプレットがロードされていないときに、いずれかの API が呼び出された場合、ブラウザは JavaScript に NullPointer例外を渡します。
パラメータ: なし。
リターン:
ZIEWeb-Client ページがロードされている場合は true を返し、それ以外の場合は false を返します。
• 関数sendKeys1 (文字列)
これらndKeys メソッドは、キーのストリングを表示スペースに送信します。この文字列は、テキスト文字と特殊キー (Enter キー、Tab キー、 PageUp キーなど) の両方を含むキーボードからの一連のキー入力と考えることができます。これらの特殊キーは、ニーモニックと呼ばれる、角括弧で区切られたキーワードで表されます。例えば、Enter キーのニーモニックキーワードは [Enter] です。
テキスト文字列には、いくつかの文字、またはこれらの文字とニーモニックの組み合わせを含めることができます。例えば、以下のストリングを使用して、ユーザーの ID の送信、次のフィールドにタブで移動する、ユーザーのパスワードを送信、ホストにログオンするための Enter キーを送信します。
ユーザーID[タブ]パスワード[入力]
左または右に角括弧を送信するには、文字を 2 重にする必要があります。左角括弧を送信するには、'[[' を使用します。右角括弧を送信するには、']]' を使用します。
このsendKeys の署名は、指定されたテキスト文字列を、現在選択されているセッションの現在カーソル位置に送信します。
パラメータ:
テキスト: 送信される文字とアシストキーのニーモニックのストリングです。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数sendKeys2 (文字列セッション名、文字列)
sendKeys メソッドのこのシグニチャは、指定されたセッションの現在のカーソル位置に、指定されたテキスト文字列を送信します。
パラメータ:
sessionName : キーが送信されるセッションのフルネーム
テキスト: 送信される文字とアシストキーのニーモニックのストリングです。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | ニーモニックまたは例外エラー |
• 関数sendKeys3 (文字列 sessionName, 文字列text, intpos)
sendKeys メソッドのこの署名は、指定されたテキスト文字列を、指定されたセッションの指定されたカーソル位置に送信します。キーが送信される前に、カーソルを指定の位置に移動します。
パラメータ:
sessionName : キーが送信されるセッションのフルネーム。
テキスト: 送信される文字とアシストキーのニーモニックのストリングです。
post : キーが送信される線形位置。
線形カーソルの位置は、表示スペースが 1 次元配列にマップされていると仮定して決定されます。2 次元配列の座標は、式 (y - 1) * numCol + x を使用して、1 次元配列にマップできます。例えば、24 x 80 表示スペースの 10, 15 にあるカーソルの線形位置は、9*80+15=735 です。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | ニーモニックまたは例外エラー: または位置が無効です。または例外エラー |
• 関数sendKeys4 (文字列セッション名, 文字列text, int column, int column)
sendKeys メソッドのこの署名は、指定されたテキスト文字列を、指定されたセッションの指定されたカーソル位置に送信します。キーが送信される前に、カーソルを指定の座標に移動します。
パラメータ:
sessionName : キーが送信されるセッションのフルネーム。
テキスト: 送信される文字とアシスタントキーのニーモニックの文字列
column : キーが送信される開始行。
column : キーが送信される開始列。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | ニーモニックまたは例外 エラー: または 行または列は無効です。または例外エラー |
• 関数setString1 (ストリングテキスト)
setString メソッドは、表示スペースにストリングを送ります。ストリングを表示スペースにコピーする前に、2 バイト文字セット (DBCS) 文字を自動的に複製します。
変更されたストリングは、無保護フィールドのみに上書きされます。保護フィールドからはみ出た文字列はすべて破棄されます。
このsetString の署名は、現在選択されているセッションの現在カーソル位置にある場所に、指定された文字列を送信します。
パラメータ:
テキスト:表示スペースに配置されるストリング。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 入力ストリングが NULL であるか、例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数setString2 (文字列セッション名、文字列text)
setString メソッドのこのシグニチャは、指定されたセッションの現在のカーソル位置に、与えられた文字列を送信します。
パラメータ:
sessionName : 文字列の送信先となるセッションのフルネーム
テキスト: 表示スペースに配置されるストリング。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 入力ストリングが NULL であるか、例外エラー |
• 関数 setString3 (文字列セッション名, 文字列text, intpos)
setString メソッドのこのシグニチャは、指定されたセッションの指定されたカーソル位置にある文字列を送信します。文字列を書き込む前に、カーソルを指定の位置に移動します。
パラメータ:
sessionName : 文字列の送信先となるセッションのフルネーム。
テキスト: 表示スペースに配置されるストリング
pos : 文字列が書き込まれる線形位置
線形カーソルの位置は、表示スペースが 1 次元配列にマップされていると仮定して決定されます。2 次元配列の座標は、式 (y - 1) * numCol + x を使用して、1 次元配列にマップできます。したがって、24 x 80 表示スペースの 10、15 にあるカーソルの線形位置は、9*80+15=735 になります。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | NULL 入力ストリング。または位置が無効です。または例外エラー |
• 関数 setString4 (String sessionName, 文字列text, int column, int column)
setString メソッドのこのシグニチャは、指定されたセッションの指定されたカーソル位置にある文字列を送信します。文字列を書き込む前に、カーソルを指定の座標に移動します。
パラメータ:
sessionName : 文字列の送信先となるセッションのフルネーム。
テキスト: 表示スペースに配置されるストリング
column : 文字列の書き込みの開始行。
column : 文字列を書き込む開始列。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | NULL 入力ストリング。または行または列が無効です。または例外エラー |
• 関数 getString ()
getString メソッドは、TEXT_PLANE パラメーターを使用して、表示スペースからテキストプレーン情報を検索します。テキストプレーンデータが返される前に、重複する DBCS 文字を削除します。
データは、表示スペースの開始から、JSHostOnDemand アプレットのバッファが一杯になるか、テキストプレーン全体がコピーされるまで、返されます。ユーザーは、String オブジェクトの長さ変数を使用して、戻されたストリングにコピーされた文字数を取得することができます。または、 getString 呼び出しの直後に getStringLength メソッドを呼び出すことにより、戻されたストリングにコピーされた文字数を取得できます。
getString のこのシグニチャーは、表示スペースの開始で現在選択されているセッションからデータを取得します。
パラメータ: なし
リターン:
| 値 | 一定 | 説明 |
| 0 | 正常に実行された場合、表示スペースの開始からのデータのストリングを返します。 | |
| -1 | STR_INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | STR_EXCEPTION_ERROR | 例外エラー |
| -3 | STR_NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数 getString1 (ストリングセッション名)
getString メソッドのこのシグニチャーは、指定されたセッションの表示スペースの開始からデータを取得します。
パラメータ:
sessionName : データの読み取り元のセッションのフルネーム。
リターン:
| 値 | 一定 | 説明 |
| 0 | 正常に実行された場合、表示スペースの開始からのデータのストリングを返します。 | |
| -1 | STR_INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | STR_EXCEPTION_ERROR | 例外エラー |
• 関数 getString3 (ストリングセッション名, intpos, int length)
getString メソッドのこのシグニチャは、指定された数のプレーン位置がコピーされるまで、指定されたセッションの指定された位置の最初にあるデータを取得します。
パラメータ:
sessionName : データの読み取り元のセッションのフルネーム。
pos : 開始位置。
長さ: コピーするプレーン位置の数。
リターン:
| 値 | 一定 | 説明 |
| 0 | 正常に実行された場合、指定された位置から指定された数の面の位置までのデータの文字列を返します。 | |
| -1 | STR_INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | STR_EXCEPTION_ERROR | 位置が範囲外または例外エラーです |
• 関数 getString4 (ストリング sessionName, int column, int column, int length)
getString メソッドのこのシグニチャは、指定されたセッションから指定された座標の開始位置にあるデータを、指定された数の平面位置がコピーされるまでの間、データを取得します。
パラメータ:
sessionName : データの読み取り元のセッションのフルネーム。
column : 開始行。
column は開始列です。
長さ: コピーするプレーン位置の数。
リターン:
| 値 | 一定 | 説明 |
| 0 | 正常に実行された場合、指定された座標から指定された数の平面位置までのデータの文字列を返します。 | |
| -1 | STR_INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | STR_EXCEPTION_ERROR | 座標が範囲外または例外エラーです |
• 関数 getStringLength ()
getStringLength メソッドは、最後の getString 呼び出しで返された文字列オブジェクトにコピーされた文字数を返します。
パラメータ: なし
リターン:
getString によって返されたオブジェクト (文字列) にコピーされた特性の数または 0。
• 関数inputInhibited ()
inputInhibited メソッドは、現在選択されているセッションが相互作用 (キー入力の送信や他の API メソッドの呼び出しなど) を実行できるかどうかをチェックします。カーソルがホスト画面の書き込み保護領域にあるとき、またはホストセッションがアクティブではないとき、sendKeys API 呼び出しの結果としてキーボード/画面をロックできます。Reset API を使用してキーボードのロックを解除します。
パラメータ: なし。
リターン:
| 値 | 禁止インジケータ | OIA ストリング |
| 0 | インヒビット_NOTINHIBITED | 正常に実行された場合、指定された座標から指定された数の平面位置までのデータの文字列を返します。 |
| 1 | インヒビット_SYSTEMWAIT | 「X SYSTEM」または「X[]」 |
| 2 | インヒビット_COMMCHECK | 'X COMMxxx' |
| 3 | インヒビット_PROGCHECK | 'X PROGxxx' |
| 4 | インヒビット_MACHCHECK | 'X MACHxxx' |
| 5 | インヒビット_OTHERINHIBIT |
| 値 | 一定 | 説明 |
| -1 | INVALID_SESSION_NAME | セッション名が無効です |
| -2 | EXCEPTION_ERROR | 例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数inputInhibited1 (ストリングセッション名)
inputInhibited メソッドのこの署名は、指定されたセッションで相互作用 (キー入力の送信や他の API メソッドの呼び出しなど) を行う準備ができているかどうかをチェックします。カーソルがホスト画面の書き込み保護領域にあるとき、またはホストセッションがアクティブではないとき、sendKeys API 呼び出しの結果としてキーボード/画面をロックできます。Reset API を使用してキーボードのロックを解除します。
パラメータ:
sessionName : チェックを実行するセッションのフルネーム。
リターン:
| 値 | 禁止インジケータ | OIA ストリング |
| 0 | インヒビット_NOTINHIBITED | 正常に実行された場合、指定された座標から指定された数の平面位置までのデータの文字列を返します。 |
| 1 | インヒビット_SYSTEMWAIT | 「X SYSTEM」または「X[]」 |
| 2 | インヒビット_COMMCHECK | 'X COMMxxx' |
| 3 | インヒビット_PROGCHECK | 'X PROGxxx' |
| 4 | インヒビット_MACHCHECK | 'X MACHxxx' |
| 5 | インヒビット_OTHERINHIBIT |
| 値 | 一定 | 説明 |
| -1 | INVALID_SESSION_NAME | セッション名が無効です |
| -2 | EXCEPTION_ERROR | 例外エラー |
• ファンクションリセット ()
reset メソッドは、現在選択されているセッションのロックされたキーボードをリセットします。inputInhibited メソッドがゼロ以外の値を返した場合、このメソッドを呼び出すことによってキーボードをリセットできます。sendKeys メソッドを使用して、'[reset]' ニーモニックを発行します。
パラメータ: なし。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | セッション名が無効です |
| -2 | EXCEPTION_ERROR | 例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数reset1 (ストリングセッション名)
リセットメソッドのこの署名は、指定したセッションのロックされたキーボードをリセットします。inputInhibited メソッドがゼロ以外の値を返した場合、このメソッドを呼び出すことによってキーボードをリセットできます。'[reset]' ニモニックはsendKeys メソッドを使用して発行します。
パラメータ:
sessionName : キーボードがリセットされたセッションのフルネーム
リターン:
sendKeys が正常に実行された場合は 0 を返します。それ以外の場合は、負の数を返します。
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | セッション名が無効です |
| -2 | EXCEPTION_ERROR | 例外エラー |
• public booleanisCommReady ()
isCommReady メソッドは、現在選択されているセッションがホストと通信する準備ができているかどうかをチェックします。通信状態のステータスを返します。このメソッドは、通信回線の障害またはセッションの異常終了を検出する方法を提供します。
パラメータ: なし。
戻り値: ホストと通信の準備ができている場合は true を返します。ホストの通信準備ができていなければ false を返します。またはアクティブなセッションがありません。または、例外エラーが発生しました。
• public boolean isCommReady1 (ストリングセッション名)
isCommReady メソッドのこの署名は、指定されたセッションがホストと通信する準備ができているかどうかをチェックします。通信状態のステータスを返します。このメソッドは、通信回線の障害またはセッションの異常終了を検出する方法を提供します。
パラメータ:
テキスト: チェックが実行されるセッションのフルネーム。
戻り値: ホストと通信の準備ができている場合は true を返します。ホストの通信準備ができていなければ false を返します。またはセッション名が無効です。または、例外エラーが発生しました。
• 関数 waitForStringInRect8 (文字列, テキスト, intsRow, intsCol, inteRow, inteCol, ロングタイムアウト, booleanwaitForInput, booleancaseセンシティブ)
waitForStringInRect メソッドは、現在選択されているセッションの、指定された矩形に入力テキスト文字列が表示されるまで、同期的に待機します。waitForInput パラメーターが真の場合、これも、セッションが入力可能な状態になったことを OIA が示すまで待機します。このように、このメソッドは、画面認識と OIA 制限されていない (データ通信も、キーストロークを入力できる。例えば、キーボードのロック解除も) 機能を提供します。このメソッドは、ホスト画面の同期/タイミング/ロックの問題を避けるため、画面にデータを送信する前に使用する必要があります。sRow と sCol パラメーターが 1 に設定され、eRow と eCol パラメーターが -1 に設定されている場合、表示スペース全体で入力ストリングがスキャンされます。指定された文字列を含むホスト画面が指定された時間表示されない場合、待機は終了します。
パラメータ:
テキスト: 待機する文字列。
s行: 長方形の左上隅の行位置。
sCol :長方形の左上隅の列位置。
e行 :長方形の右下の角の行位置。
eCol :長方形の右下の隅の列の位置。
timeout : 待機時間 (ミリ秒)。無制限に待機する場合は -1 を指定します。
waitForInput : 真の場合、セッションの入力準備ができたことを OIA が示すまで待機します。
caseセンシティブ: true の場合、テキスト文字列待機で大文字と小文字が区別されます。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 指定されたストリングは、表示スペースの指定された長方形で見つかります。 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 中断例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
| -4 | TIMER_EXPIRED | 指定された文字列を含むホスト画面が到着する前に、タイマーが終了しました |
• 関数 waitForStringInRect9 (文字列セッション名, 文字列text, intsRow, intsCol, inteRow, inteCol, 長いタイムアウト, booleanwaitForInput, booleancaseセンシティブ)
waitForStringInRect メソッドは、入力されたテキスト文字列が、指定されたセッションの、指定された四角形に表示されるまで、同期的に待機します。waitForInput パラメーターが真の場合、これも、セッションが入力可能な状態になったことを OIA が示すまで待機します。このように、このメソッドは、画面認識と OIA 制限されていない (データ通信も、キーストロークを入力できる。例えば、キーボードのロック解除も) 機能を提供します。このメソッドは、ホスト画面の同期/タイミング/ロックの問題を避けるため、画面にデータを送信する前に使用する必要があります。sRow と sCol パラメーターが 1 に設定され、eRow と eCol パラメーターが -1 に設定されている場合、表示スペース全体がスキャンされて入力ストリングがあります。指定された文字列を含むホスト画面が指定された時間表示されない場合、待機は終了します。
パラメータ:
sessionName: 文字列の待機が行われるセッションのフルネーム。
テキスト: 待機する文字列。
s行: 長方形の左上隅の行位置。
sCol: 長方形の左上隅の列位置。
e行: 長方形の右下隅の行位置。
eCol: 長方形の右下隅の列位置。
timeout: 待機時間 (ミリ秒)。無制限に待機する場合は -1 を指定します。
waitForInput: 真の場合、セッションの入力準備ができたことを OIA が示すまで待機します。
caseセンシティブ: もし真の場合、文字列待機で大文字と小文字が区別されます。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 指定されたストリングは、表示スペースの指定された長方形で見つかります。 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 中断例外エラー |
| -4 | TIMER_EXPIRED | 指定された文字列を含むホスト画面が到着する前に、タイマーが終了しました |
• 関数待機ストリングInRect8 (ストリングtext, intsRow, intsCol, inteRow, inteCol, 長いタイムアウト, booleanwaitForInput, booleancaseセンシティブ)
待機中のメソッドは、入力テキスト文字列が現在選択されているセッションの指定された Rect 型からなくなるまで、同期的に待機します。waitForInput パラメーターが真の場合、これも、セッションが入力可能な状態になったことを OIA が示すまで待機します。したがって、このメソッドは、画面認識と OIA 制限なし (データ通信はなく、キーストロークを入力できる。例えば、キーボードのロック解除) 機能を提供します。このメソッドはホスト画面にデータを送信する前に使用して、ホスト画面の同期/タイミング/ロックの問題を回避する必要があります。この機能は、画面がタイムリーに処理されない、より低速の通信回線または低速のホストでも便利です。これは、ホスト画面がフラッシュされたことを呼び出し側に示します。sRow と sCol パラメーターが 1 に設定され、eRow と eCol パラメーターが -1 に設定されている場合、入力ストリングを見つけるために表示スペース全体が使用されます。指定された文字列を含むホスト画面が指定された時間内にフラッシュされない場合、待機は終了します。
パラメータ:
sessionName: 文字列の待機が行われるセッションのフルネーム。
テキスト: 待機する文字列。
s行: 長方形の左上隅の行位置。
sCol: 長方形の左上隅の列位置。
e行: 長方形の右下隅の行位置。
eCol: 長方形の右下隅の列位置。
timeout: 待機時間 (ミリ秒)。無制限に待機する場合は -1 を指定します。
waitForInput: 真の場合、セッションの入力準備ができたことを OIA が示すまで待機します。
caseセンシティブ: もし真の場合、文字列待機で大文字と小文字が区別されます。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 指定されたストリングは、表示スペースの指定された長方形で見つかります。 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 中断例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
| -4 | TIMER_EXPIRED | 指定された文字列を含むホスト画面が到着する前に、タイマーが終了しました |
• 関数待機中文字列InRect9 (文字列セッション名, 文字列text, intsRow, intsCol, inteRow, inteCol, 長いタイムアウト, booleanwaitForInput, booleancaseセンシティブ)
待機中のメソッドは、入力されたテキスト文字列が指定されたセッションの指定された Rect 型からなくなるまで、同期的に待機します。waitForInput パラメーターが真の場合、これも、セッションが入力可能な状態になったことを OIA が示すまで待機します。このように、このメソッドは、画面認識と OIA 制限されていない (データ通信や、キーボードのロック解除を解除した場合のようにキーストロークを入力できる) 機能を提供します。このメソッドはホスト画面にデータを送信する前に使用して、ホスト画面の同期/タイミング/ロックの問題を回避する必要があります。この機能は、画面がタイムリーに処理されない、より低速の通信回線または低速のホストでも便利です。これは、ホスト画面がフラッシュされたことを呼び出し側に示します。sRow と sCol パラメーターが 1 に設定され、eRow と eCol パラメーターが -1 に設定されている場合、入力ストリングを見つけるために表示スペース全体が使用されます。指定された文字列を含むホスト画面が指定された時間内にフラッシュされない場合、待機は終了します。
パラメータ:
sessionName: 文字列の待機が行われるセッションのフルネーム。
テキスト: 待機する文字列。
s行: 左上隅の行の位置。
sCol: 長方形の左上隅の列位置。
e行: 長方形の右下隅の行位置。
eCol: 長方形の右下隅の列位置。
timeout: 待機時間 (ミリ秒)。無制限に待機する場合は -1 を指定します。
waitForInput:真の場合、セッションの入力準備ができたことを OIA が示すまで待機します。
caseセンシティブ:真の場合、「待機」という文字列で大文字と小文字が区別されます。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 指定されたストリングは、表示スペースの指定された長方形で見つかります。 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 中断例外エラー |
| -4 | TIMER_EXPIRED | 指定された文字列を含むホスト画面が到着する前に、タイマーが終了しました |
• 関数 startMacro1(文字列 macroName)
startMacro メソッドのこの署名は、現在選択されているセッションで指定されたマクロを開始します。このメソッドを使用すると、マクロを開始できます。このマクロは、現在選択されているセッションで事前定義されている必要があります。
パラメータ:
macroName: 開始するマクロの名前。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 無効なマクロ名または例外エラー |
| -3 | NO_ACTIVE_SESSION | アクティブなセッションがありません |
• 関数 startMacro2(文字列 sessionName, 文字列 MACroName)
startMacro メソッドのこの署名は、指定されたセッションで指定されたマクロを開始します。このメソッドを使用すると、マクロを開始できます。マクロは、指定したセッションで事前に定義しておく必要があります。
パラメータ:
sessionName: マクロを開始するために使用されるセッションのフルネーム。
macroName: 開始するマクロの名前。
リターン:
| 値 | 一定 | 説明 |
| 0 | OK | 成功 |
| -1 | INVALID_SESSION_NAME | 無効なセッション名か、セッションがアクティブではありません |
| -2 | EXCEPTION_ERROR | 無効なマクロ名または例外エラー |
• 関数 getErrorMessage ()
getErrorMessage メソッドは、最後の API 呼び出しから保存されたエラーメッセージを返します。上記の API 呼び出しのいずれかのために、Z と I の Web (ZIEWeb) または Java のエミュレーターから例外がスローされた場合、このメソッドは例外メッセージを返します。
Web (ZIEWeb) または Java 用 Z と I のエミュレーターによってスローされた例外はすべて、JSHostOnDemand アプレットによってキャッチされ、保存されます。例外メッセージは、上記の API 呼び出しの後にこのメソッドを呼び出すことにより、JavaScript コードで取得できます。
パラメータ:なし。
リターン:
エラーメッセージ文字列付きで作成された場合は、最後の例外のエラーメッセージ文字列。エラーメッセージなしで作成された場合は null 。または無効なセッション名。などが含まれます。
設定方法:
設定ステップ-
1. アプリケーション (Web ページ) の <head> セクションにSession Manager API JavaScript ファイルをインクルードします
コード:
<script src="http://<IP_of_ZIEWeb_Server>:<ポート>/zieweb/js/SessionManagerAPI.js">
例: <script src= http://localhost:9080/zieweb/js/セッションマネージャAPI.js > </script>
2. sessionManagerAPI のオブジェクトを作成します。 JavaScript の <script> タグの内部
コード: varhod_applet = new hod_Session();
3. API の使用を開始するには、まず以下の API 関数呼び出しを使用して接続を確立する必要があります:
コード: hod_applet.createConnection(url);
**URL: ZIEWeb ページの URL を指定します
例: http://localhost:9080/zieweb/abc_page.html
4. 接続が確立され、ZIEWeb-Client ウィンドウが開いたら、JavaScript オブジェクトを使用して API 呼び出しを行います。
コード:
varreturnValue=hodApplet.getSessionID(),
varreturnValue=hodApplet.connectSession()
5. サンプルアプリケーションページは、ZIEWeb-Client がインストールされているのと同じサーバー (WAS) に配置する必要があります。
既知の問題と制限:
1.Session Manager API を介してブラウザ間通信を行うことはできません。
2. callCustomerFunction はサポートされていません。
3. WorkAround with iframe はサポートされていません。
4. ホストファンクション pnumonic ([pf1]..[pf24],[Enter]) の後のテキストは無視されます。
例: [pf4]テキストの一部