エミュレーター・プログラミング

EHLLAPI 関数

この章では、パーソナル・コミュニケーションズの EHLLAPI の個々の関数の詳細および EHLLAPI プログラム・サンプラーの使用方法について説明します。関数は、関数名によりアルファベット順に並べられています。標準と拡張の両方のインターフェースについて、これらの関数を説明します。

注:
本章では、WinHLLAPI、IBM 標準 32 ビット HLLAPI および 16 ビット EHLLAPI を標準インターフェースと呼び、IBM 拡張 32 ビット EHLLAPI を拡張インターフェースと呼びます。

コード・ページ 1390/1399 および 1137 のためのユニコード・サポート

次の EHLLAPI 関数は、ユニコード・セッションの日本語コード・ページ 1390/1399 とヒンディ語コード・ページ 1137 サポートで使用できます。

日本語コード・ページ 1390/1399 とヒンディ語コード・ページ 1137 の詳細については、それぞれの関数ごとに特定のセクションを参照してください。

注:

  1. PCOMM セッションに送信するユニコード文字を含むストリングは、コード・ページ 1390/1399 では WCHAR *、コード・ページ 1137 では char * の型キャストであるようにしてください。

  2. EHLLAPI 1390/1399 ユニコード機能は 3270 および 5250 セッションでのみ選択可能です。EHLLAPI 1137 ユニコード機能は 5250 セッションでのみ選択可能です。

ページ・レイアウトについての規則

すべての EHLLAPI 関数呼び出しは、必要な情報を素早く検索できるように同一の形式で表されています。形式は次のとおりです。

関数名 (関数番号)

前提呼び出し

呼び出しパラメーター

戻りパラメーター

使用上の注意

前提呼び出し

「前提呼び出し」では、その関数に先行して呼び出しておく必要がある関数をリストしています。

呼び出しパラメーター

「呼び出しパラメーター」には、その EHLLAPI 関数を呼び出すためにプログラム内で定義しなければならないパラメーターをリストし、それらのパラメーターを定義する方法を説明しています。関数にパラメーターがない場合は、 NA (不適用) と記されます。 Set Session Parameters (9) 関数呼び出しで定義されたセッション・パラメーターの値でパラメーターをオーバーライドできる場合は、そのセッション・パラメーター名が示されています。

戻りパラメーター

「戻りパラメーター」には、その EHLLAPI 関数を呼び出した後にプログラムが受け取るはずのパラメーターをリストし、それらのパラメーターをどのように解釈するかを説明します。

使用上の注意

「使用上の注意」には、その関数に影響を与えるセッション・オプションをリストします。また、関数の使用に関する技術情報とアプリケーション開発のヒントも提供します。

EHLLAPI 関数の要約

表 6 は EHLLAPI 関数を要約したものです。

表 6. EHLLAPI 関数の要約

関数 3270 5250 VT
Connect Presentation Space (1) YES YES YES
Disconnect Presentation Space (2) YES YES YES
Send Key (3) YES YES YES
Wait (4) YES YES YES
Copy Presentation Space (5) YES YES YES
Search Presentation Space (6) YES YES YES
Query Cursor Location (7) YES YES YES
Copy Presentation Space to String (8) YES YES YES
Set Session Parameters (9) YES YES YES
Query Sessions (10) YES YES YES
Reserve (11) YES YES YES
Release (12) YES YES YES
Copy OIA (13) YES YES YES
Query Field Attribute (14) YES YES YES
Copy String to Presentation Space (15) YES YES YES
Pause (18) YES YES YES
Query System (20) YES YES YES
Reset System (21) YES YES YES
Query Session Status (22) YES YES YES
Start Host Notification (23) YES YES YES
Query Host Update (24) YES YES YES
Stop Host Notification (25) YES YES YES
Search Field (30) YES YES YES
Find Field Position (31) YES YES YES
Find Field Length (32) YES YES YES
Copy String to Field (33) YES YES YES
Copy Field to String (34) YES YES YES
Set Cursor (40) YES YES YES
Start Close Intercept (41) YES YES YES
Query Close Intercept (42) YES YES YES
Stop Close Intercept (43) YES YES YES
Query Additional Field Attribute DRB NO YES NO
Start Keystroke Intercept (50) YES YES YES
Get Key (51) YES YES YES
Post Intercept Status (52) YES YES YES
Stop Keystroke Intercept (53) YES YES YES
Lock Presentation Space API (60) YES NO NO
Lock Window Services API (61) YES NO NO
Start Communication Notification (80) YES YES YES
Query Communication Event (81) YES YES YES
Stop Communication Notification (82) YES YES YES
Send File (90) YES YES NO
Receive File (91) YES YES NO
Cancel File Transfer (92) YES YES YES
Convert Position または Convert RowCol (99) YES YES YES
Connect Window Services (101) YES YES YES
Disconnect Window Service (102) YES YES YES
Query Window Coordinates (103) YES YES YES
Window Status (104) YES YES YES
Change Switch List LT Name (105) YES YES YES
Change PS Window Name (106) YES YES YES
Start Playing Macro (110) YES YES YES
Connect for Structured Fields (120) YES NO NO
Disconnect from Structured Fields (121) YES NO NO
Query Communications Buffer Size (122) YES NO NO
Allocate Communications Buffer (123) YES NO NO
Free Communications Buffer (124) YES NO NO
Get Request Completion (125) YES NO NO
Read Structured Fields (126) YES NO NO
Write Structured Fields (127) YES NO NO
       

Allocate Communications Buffer (123)


3270 5250 VT
YES NO NO

Allocate Communications Buffer 関数を使用して、オペレーティング・システムからバッファーを取得することができます。バッファー・アドレスは、 Read Structured Fields (126) と Write Structured Fields (127) の両方の関数に渡す必要があります。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 123 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 6 にしてください。 必ず 8 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 ～ 2 1 ～ 4 32 ビットまたは 16 ビットのバッファー長。 (0 < size <= (64 KB-256 bytes)=X'FF00')
3 ～ 6 5 ～ 8 割り振られるバッファーの 32 ビット・アドレス (戻される)。

戻りパラメーター


戻りコード 説明
0 Allocate Communications Buffer 関数は正常終了しました。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
11 リソースが使用できません。(メモリーが使用できません。)

使用上の注意

  1. EHLLAPI は、オペレーティング・システムのメモリー・マネージメントからバッファーを取得し、そのバッファー・アドレスを戻りパラメーター・ストリングに置きます。要求バッファー・サイズ (長さ) もパラメーター・ストリングに渡されます。バッファー・サイズは、1 バイトから 64 KB - 256 バイト (X'FF00' バイト) の長さです。

    バッファー・サイズに関する情報は、『Query Communications Buffer Size (122)』を参照してください。

  2. この関数で取得したバッファーは、別のプロセス間では共用できません。共用しようとすると、アプリケーションで予測不可能な結果が生じることがあります。
  3. EHLLAPI アプリケーションは、Free Communications Buffer (124) 関数を発行して、割り振られたメモリーを解放する必要があります。
  4. 1 つのアプリケーションに割り振ることのできるバッファーは 10 個が限度です。この限度に達すると、リソースが使用できないことを示す戻りコード (RC=11) が戻されます。
  5. Reset System (21) 関数は、この関数が割り振ったバッファーを解放します。

Cancel File Transfer (92)


3270 5250 VT
YES YES YES

Cancel File Transfer 関数を使用すると、現行の EHLLAPI が指定されたセッションに対して開始した、 Send File または Receive File が直ちに戻されます。

前提呼び出し

Send File (90) または Receive File (91)

呼び出しパラメーター


  拡張インターフェース
関数番号 必ず 92 にしてください。
データ・ストリング ホスト表示スペースの 1 文字の短縮名。ホスト接続表示スペースへの更新要求を示すブランクまたは NULL。
長さ 4 が暗黙指定されます。
PS 位置 NA

呼び出しデータ構造には、以下の要素が含まれます。

バイト位置 定義
1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター


戻りコード 定義
0 関数は正常終了しました。
1 誤った PSID が指定されました。
8 この PSID に対して、先に Start Communication Notification (80) 関数が呼び出されていません。
9 システム・エラーが発生しました。

使用上の注意

Send File (90) および Receive File (91) の両方がブロッキング呼び出ししているため、この関数は、常に、異なるスレッド上で発行されなければなりません。

Change PS Window Name (106)


3270 5250 VT
YES YES YES

Change PS Window Name 関数を使用すると、アプリケーションは表示スペース・ウィンドウに新しい名前を指定したり、デフォルト名にリセットすることができます。

前提呼び出し

Connect Window Services (101)

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 106 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず指定してください (注を参照)。 必ず 68 にしてください。
PS 位置 NA
注:
データ・ストリング長は必ず指定してください (通常、PC/3270 では 3 ～ 63、PC400 では 4 ～ 63、拡張インターフェースでは 68)。

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 5 変更要求オプションの値。次のうちの 1 つを選択してください。
  • 表示スペース・ウィンドウ名を変更する時は、X'01'
  • 表示スペース・ウィンドウ名をリセットする時は、X'02'
3 ～ 63 6 ～ 66 終止符バイトを含む 1 (PC/3270 の場合) または 2 (PC400 の場合) から 61 バイトの ASCII ストリング。 ASCII ストリングは必ず NULL 文字で終了してください。このストリングには、NULL 文字の前に少なくとも 1 個の非 NULL 文字が必要です。
67 ～ 68 予約済み

戻りパラメーター


戻りコード 説明
0 Change PS Window Name 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
12 セッションが停止しました。

使用上の注意

ストリングは、最初に NULL 文字が検出されたところで終了します。 NULL 文字は、指定されたストリングの長さを変更します。 NULL 文字が指定した長さの終わりにない場合、指定した長さのところで最後のバイトが NULL 文字に置き換えられ、データ・ストリングの残りの部分は失われます。指定した長さより短いところで NULL 文字が検出された場合、ストリングはそこで切り捨てられ、データ・ストリングの残りの部分は失われます。

アプリケーションが終了する前に表示スペース名のリセットに失敗すると、出口リスト処理がその表示スペース名をリセットします。

Change Switch List LT Name (105)


3270 5250 VT
YES YES YES

Change Switch List LT Name 関数を使用すると、アプリケーションは選択した論理端末 (LT) に対するスイッチ・リストの変更またはリセットができます。アプリケーションは呼び出し時に、スイッチ・リストに挿入する名前を指定する必要があります。

注:
この関数は コミュニケーション・マネージャー EHLLAPI との互換性を保つためのもので、Change PS Window Name (106) 関数と同じ結果になります。

前提呼び出し

Connect Window Services (101)

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 105 にしてください。
データ・ストリング 次の表を参照してください。
長さ 通常は 4 ～ 63 です。 必ず 68 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 5 変更要求オプション。次の中から選びます。
  • スイッチ・リストの LT 名を変更する時は、X'01'
  • スイッチ・リストの LT 名をリセットする時は、X'02'
3 ～ 63 6 ～ 66 終止符バイトを含む 2 から 61 バイトの ASCII ストリング。 ASCII ストリングは必ず NULL 文字で終了してください。このストリングには、NULL 文字の前に少なくとも 1 個の非 NULL 文字が必要です。
67 ～ 68 予約済み

戻りパラメーター


戻りコード 説明
0 Change Switch List LT Name 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
12 セッションが停止しました。

使用上の注意

ストリングは、最初に NULL 文字が検出されたところで終了します。 NULL 文字は、指定されたストリングの長さを変更します。 NULL 文字が指定した長さの終わりにない場合、指定した長さのところで最後のバイトが NULL 文字に置き換えられ、データ・ストリングの残りの部分は失われます。指定した長さより短いところで NULL 文字が検出された場合、ストリングはそこで切り捨てられ、データ・ストリングの残りの部分は失われます。

アプリケーションが終了する前にスイッチ・リスト LT 名のリセットに失敗すると、出口リスト処理がそのスイッチ・リスト LT 名をリセットします。

Connect for Structured Fields (120)


3270 5250 VT
YES NO NO

Connect for Structured Fields 関数を使用すると、アプリケーションは、エミュレーション・プログラムへの接続を確立し、ホスト・アプリケーションとの間で構造化フィールド・データを交換することができます。ワークステーションのアプリケーションは、Query Reply (照会・応答) データ・フィールドを提供し、パラメーター・ストリング内でそれを指していなければなりません。エミュレーターから戻された Destination/Origin ID はアプリケーションに戻されます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 120 にしてください。
データ・ストリング 次の表を参照してください。
長さ 7 または 11 にしてください。 必ず 16 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 ～ 5 5 ～ 8 Query Reply (照会・応答) データ・バッファーのアドレス
6 ～ 7 9 ～ 10 戻される Destination/Origin 固有の ID(16 ビット・ワード)
11 ～ 12 予約済み
8 ～ 11 13 ～ 16 この位置にあるデータは EHLLAPI に無視されます。ただし、移行プログラムでこの位置にデータを指定していても、エラーは発生しません。このデータはアプリケーションの移行時に互換性を保つために設けられています。

戻りパラメーター


戻りコード 説明
0 Connect for Structured Fields 関数は正常終了しました。
1 指定されたホスト表示スペースの短縮 セッション ID が無効か、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
10 エミュレーション・プログラムはこの関数をサポートしていません。
32 アプリケーションは通信用にこのセッションにすでに接続しています。(正常接続)
39 1 つの DDM セッションがこのセッションにすでに接続しています。

使用上の注意

  1. EHLLAPI は Destination/Origin ID (DOID) 自己定義パラメーター (SDP) の Query Reply (照会・応答) バッファーを走査して、Query Reply の DOID フィールドの内容を決定します。この値が X'0000' の場合は、エミュレーターが DOID をアプリケーションに割り当て、EHLLAPI は割り当てられた ID で Query Reply の DOID フィールドを埋めます。アプリケーションが Query Reply の DOID フィールドに指定した値がゼロ以外の値である場合は、ID は前もって割り当てられていないものと見なされ、エミュレーターは指定された値をアプリケーションの DOID として割り当てます。指定された DOID がすでに使用中の場合には、EHLLAPI は戻りコード 2 を戻します。
  2. アプリケーションは、Query Reply データ構造をアプリケーションの専用メモリー内に作成する必要があります。 EHLLAPI がサポートする Query Reply データ構造の形式と使用法についての詳細は、付録 A, EHLLAPI がサポートする Query Reply データ構造を参照してください。
  3. Query Reply のデータについて簡単なチェックが実行されます。 ID と構造の長さについてのみ有効かどうかチェックされます。
  4. ホスト・セッションごとに接続できる DDM 基本タイプは 1 つだけです。 DDM 接続が Destination/Origin ID (DOID) 用に自己定義パラメーター (SDP) をサポートしている場合は、複数接続できます。
  5. 戻りコード RC=32 または RC=39 を受信した場合、アプリケーションは選択したセッションにすでに接続しており、表示スペースを注意して使用する必要があります。 SRPI、ファイル転送、および他の EHLLAPI アプリケーションとの競合が生じる可能性があります。

Connect Presentation Space (1)


3270 5250 VT
YES YES YES

Connect Presentation Space 関数は、EHLLAPI アプリケーション・プログラムとホスト表示スペースとの接続を確立します。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 1 にしてください。
データ・ストリング ホスト表示スペースの 1 文字の短縮名。
長さ 1 が暗黙指定されます。 必ず 4 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター

Connect Presentation Space 関数は戻りコードを設定して、試行状況、および試行が正常終了した場合はホスト表示スペースの状況を示します。

戻りコード 説明
0 Connect Presentation Space 関数は正常終了しました。ホスト表示スペースはアンロックされ、入力の準備ができました。
1 無効なホスト表示スペース ID が指定されました。指定されたセッションが存在しないか、または、論理プリンター・セッションです。さらにこの戻りコードは、DDE/EHLLAPI 用の API Setting がオンに設定されていないことを示している場合があります。
4 接続には成功しましたが、ホスト表示スペースが使用中です。
5 接続には成功しましたが、ホスト表示スペースがロックされています (入力禁止)。
9 システム・エラーが発生しました。
11 このリソースは使用できません。ホスト表示スペースは、すでに他のシステム関数が使用しています。

使用上の注意

  1. Connect Presentation Space 関数は、 CONLOG/CONPHYS セッション・オプションの影響を受けます。
  2. 1 つの EHLLAPI アプリケーションが同時に複数の表示スペースに接続することはできません。前提関数として Connect Presentation Space 関数を必要とする呼び出しは、現在接続されている表示スペースを使用します。例えば、アプリケーションが表示スペースに A、B、C の順で接続した場合、そのアプリケーションが関数を発行するためには B または A に再度接続しなければなりません。
  3. Connect Presentation Space を必要とする各スレッドに対応する Disconnect Presentation Space (2) があるか、またはそれらのスレッドの 1 つが Reset System (21) を発行する必要があります。この機能は全スレッドに影響し、残りの接続をすべて切断します。
  4. アプリケーションが共用をサポートし (つまり、それらのアプリケーションが一緒に動作できるように開発されており、予測可能な動作が示されている)、なおかつ Set Session Parameters (9) 関数で設定したものと互換性がある読み取り/書き込みアクセス権とキーワードのオプションがある場合、複数の EHLLAPI アプリケーションで 1 つの表示スペースを共用できます。詳細については、Set Session Parameters (9)を参照してください。
  5. Connect Presentation Space 関数と Start Keystroke Intercept (50) 関数は共通のサブシステム関数を共用します。このため、あるアプリケーションによって、1 つのセッションに対してこれら 2 つの関数のうちのいずれかを共用するという要求が出され、その要求が正常に実行されると、別のアプリケーションがこれら 2 つの関数についての要求を出した場合に影響を受ける場合があります。例えば、アプリケーション A が セッションに対して、KEY$abcdefgh をキーワードとして Write アクセスで指定した Connect Presentation Space を要求し、その要求が正常に実行された場合、アプリケーション B による、あるセッションに対する Connect Presentation Space および Start Keystroke Intercept についての要求は、両方のアプリケーションで互換性のある読み取り/書き込みオプションが設定されている場合にのみ、正常に実行されます。
  6. 論理プリンター・セッションとして定義したセッションには接続できません。詳細については、「管理者ガイドおよび解説書」を参照してください。

Connect Window Services (101)


3270 5250 VT
YES YES YES

Connect Window Services 関数を使用すると、アプリケーションは表示スペース・ウィンドウを管理することができます。ウィンドウ・サービスでは、1 つの表示スペースには一度に 1 つの EHLLAPI アプリケーションしか接続できません。

ウィンドウ・サービスでは、1 つの EHLLAPI アプリケーションは同時に複数の表示スペースに接続できます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 101 にしてください。
データ・ストリング ホスト表示スペースの 1 文字の短縮セッション ID。
長さ 1 が暗黙指定されます。 必ず 4 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター


戻りコード 説明
0 Connect Window Services 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、または Sessions Window Services マネージャーが接続されていません。さらにこの戻りコードは、DDE/EHLLAPI 用の API Setting がオンに設定されていないことを示している場合があります。
9 システム・エラーが発生しました。
10 エミュレーション・プログラムはこの関数をサポートしていません。
11 このリソースは使用できません。ホスト表示スペースは、すでに他のシステム関数が使用しています。

使用上の注意

  1. 1 つの EHLLAPI アプリケーションは同時に複数の表示スペース・ウィンドウに接続できます。アプリケーションは、接続された複数の表示スペース・ウィンドウを切断しなくても、それらの間で前後に移動することができます。例えば、アプリケーションが表示スペース・ウィンドウ A、B、および C に 接続している場合、同時に A、B、および C すべてにアクセス可能となり、他のアプリケーションからは A、B、C のどれにもアクセスできません。
  2. プロセスを実行するには、Connect Window Services 関数だけで十分です。ただし、Connect Window Services を必要とする各スレッドに対応する Disconnect Window Services (102) があるか、またはそれらのスレッドの 1 つが Reset System (21) を発行する必要があります。この機能は全スレッドに影響し、残りの接続をすべて切断します。

Convert Position または Convert RowCol (99)


3270 5250 VT
YES YES YES

Convert Position または Convert RowCol 関数は、ホスト表示スペースの位置の値をディスプレイの行と桁の座標に変換したり、ディスプレイの行と桁の座標をホスト表示スペースの位置の値に変換します。この関数は、カーソル位置を変更しません。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 99 にしてください。
データ・ストリング Convert Position 関数に対してはホスト表示スペースの短縮名および P (例えば、AP はセッション A の表示スペース位置を変換します)、

あるいは、Convert RowCol 関数に対してはホスト表示スペースの短縮名および R (例えば、AR はセッション A の行と桁の座標を変換します)。

長さ データ・ストリング・パラメーターの 2 番目の文字として R を指定する場合は行 (Row)。有効な入力の下限値は 1、上限値はホスト表示スペースの構成によって異なります。 使用上の注意を参照してください。

データ・ストリング・パラメーターの 2 番目の文字として P を指定する場合は適用されません。

PS 位置 データ・ストリング・パラメーターの 2 番目の文字として R を指定する場合は桁 (Column)。有効な入力の下限値は 1、上限値はホスト表示スペースの構成によって異なり、24 から 43 の間です。 使用上の注意を参照してください。

データ・ストリング・パラメーターの 2 番目の文字として P を指定する場合は、ホスト表示スペース位置。有効な入力の下限値は 1、上限値はホスト表示スペースの構成によって異なり、1920 から 3564 の間です。 使用上の注意を参照してください。

呼び出しデータ・ストリングには次のものがあります。


バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 5 変換オプション P または R
6 ～ 8 予約済み

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
Convert Position 関数 (呼び出しデータ・ストリング内の 2 番目の文字が P) については、1 から 43 (PC/3270 の場合) または 27 (PC400 の場合) が戻されます。この値は、呼び出し PS 位置パラメーターに含まれた PS 位置を含む行の番号です。上限値は、ホスト表示スペースの構成によっては、 43 (PC/3270 の場合) または 27 (PC400 の場合) よりも小さくなります。

Convert RowCol 関数 (呼び出しデータ・ストリングの 2 番目の文字が R) の場合、0 という値は、行についての入力値 (呼び出しデータ・ストリング長パラメーター) にエラーがあることを示します。

戻りコード:
Convert Position または RowCol 関数は、4 番目の戻りパラメーターに常に戻りコードがあるという規則から除外されています。この関数に関しては、4 番目のパラメーターに戻される値は状況コードです。この状況コードには、データまたは戻りコードが含まれることがあります。予測不能な結果やエラーを避けるため、アプリケーションはこの状況コードの処理機能を備えている必要があります。

以下の状況コードが定義されています。

状況コード 説明
0 これは無効な PS 位置または桁です。
>0 これは PS 位置または桁です。
9998 無効なホスト表示スペース ID が指定されたか、またはシステム・エラーが発生しました。
9999 データ・ストリング内の 2 番目の文字が P でも R でもありません。

使用上の注意

  1. 表示スペースを構成する場合は、「管理者ガイドおよび解説書」を参照してください。
  2. 表示スペースの行や桁の数を知るには、 Query Session Status (22) 関数で戻されるデータ・ストリング・パラメーターを調べてください。Query Session Status (22)を参照してください。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

Convert Position または Convert RowCol は、クラスターの先頭に戻るためにヒンディ語が使用できます。 Convert Position または Convert RowCol の使用法は SBCS セッションと同じです。

Copy Field to String (34)


3270 5250 VT
YES YES YES

Copy Field to String 関数は、ホスト接続の表示スペース内のフィールドからストリングへ文字を転送します。

Copy Field to String 関数は、ホスト・ソース表示スペース内の文字を情報交換用日本工業規格コード (ASCII) に変換します。属性バイトやその他の通常 ASCII では表されない文字は、ブランクに変換されます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 34 にしてください。
データ・ストリング 事前に割り振りされたターゲットのデータ・ストリング。 Extended Attribute Bytes (EAB) オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは少なくともフィールドの長さの 2 倍必要です。

DBCS の場合のみ: Extended Attributes Double-byte (EAD) オプションを指定した場合、データ・ストリングの長さは最低でもフィールド長の 3 倍なければなりません。EAB と EAD の両オプションを指定した場合、データ・ストリングの長さは最低でもフィールド長の 4 倍なければなりません。

長さ コピーするバイトの数 (データ・ストリングの長さ)
PS 位置 該当フィールドを識別します。これはコピー先フィールド内のどのバイトの PS 位置でも構いません。コピー関数は常にフィールドの先頭から開始されます。

戻りパラメーター

この関数は、データ・ストリング、データ・ストリング長、戻りコードを戻します。

データ・ストリング:
ストリングはホスト表示スペース内の識別されたフィールドからのデータを含んでいます。戻されるデータ・ストリングの先頭バイトは、ホスト表示スペース内の識別されたフィールドの先頭バイトです。戻されるデータ・ストリングのバイト数は、次のうちの小さい方によって決まります。

データ・ストリング長:
戻されるデータの長さ。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Copy Field to String 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター指定でエラーが発生しました。
6 コピーするデータとコピー先フィールドのサイズが等しくありません。ストリングの長さがコピーされるフィールドよりも短い場合、データは切り捨てられます。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 ホスト表示スペースが定様式化されていません。

使用上の注意

  1. フィールドの位置および長さに関する情報は、Find Field Position (31) 関数および Find Field Length (32) 関数を使用して得ることができます。Copy Field to String 関数は保護フィールド、無保護フィールドのいずれでも使用できますが、フィールド形式 のホスト表示スペース内のフィールドに限定されています。

  2. 次のいずれかの状態が発生した時、コピーは終了します。
  3. DBCS の場合のみ: コピー先ストリングが 2 バイト文字の上位バイトで終わる場合、そのバイトはブランクに変換されます。EAD オプションを ON に設定した場合、1 文字につき 3 バイトずつ戻されます。EAB と EAD の両オプションを ON に設定した場合は、1 文字につき 4 バイトずつ戻されます。

    注:
    フィールドが表示スペースの終わりで折り返している場合、表示スペースの終わりに到達したときに折り返します。
  4. DBCS の場合のみ: Set Session Parameters (9) 関数の EAD オプションをこの関数と共に使用して、2 バイトの EAD を戻すことができます。EAB オプションを指定せずに EAD オプションを指定した場合、各文字の前に EAD が戻されます。EAB と EAD の両オプションを指定した場合、EAB の前に EAD が戻されます。
  5. EAB を戻すには、Set Session Parameters (9) 関数の EAB オプションを使用します。EAB は表示スペース上の各文字と関連しており、それぞれの文字の前に戻されます。
  6. Copy Field to String 関数は、ATTRB/NOATTRB/NULLATTRB、 EAB/NOEAB、XLATE/NOXLATE、 DISPLAY/NODISPLAY、DISPLAY/NODISPLAY、 EAD/NOEAD (DBCS 用のみ)、および NOSO/SPACESO/SO (DBCS 用のみ) のセッション・オプションによる影響を受けます。詳細については、 5、 13、 14、 17、および 20、 21 を参照してください。

    前述のように、さまざまな Copy (5、8、および 34) 関数により戻される属性は、Set Session Parameters (9) 関数の影響を受けます。関係するセッション設定パラメーターは、以下のような影響を及ぼします。

    セッション設定パラメーター
    COPY 機能への影響

    NOEAB、NOEAD
    属性は戻されません。テキストのみを表示スペースからユーザーのバッファーへコピーします。

    EAB、NOXLATE
    属性は以下の表に定義されたとおりに戻されます。

    EAB、XLATE
    表示スペースの表示に使用される色が戻されます。色は再マップできるので、XLATE と EAB が同時に ON になっている場合、属性の色は COPY 関数によって戻される色ではありません。

    EAD
    以下の表に示される 2 バイト文字セット属性が戻されます。

    戻される文字の属性を以下の表に示します。属性ビット位置は IBM 形式 (つまり、バイトの左端がビット 0) で示してあります。

    3270 の文字属性が、ホストからエミュレーターに戻されます。次の表は、EAB および NOXLATE が設定されている場合に適用されます。

    ビット位置
    		意味
    0 ～ 1 文字の強調表示

    00 = 標準

    01 = 明滅

    10 = 反転表示

    11 = 下線

    2 ～ 4 文字の色 (カラー再マップでこの色定義を一時変更できます。)

    000 = デフォルト値

    001 = 青

    010 = 赤

    011 = ピンク

    100 = 緑

    101 = 空色

    110 = 黄

    111 = 白

    5 ～ 6 文字属性

    00 = デフォルト値

    11 = 2 バイト文字

    7 予約済み

    5250 の文字属性が、ホストからエミュレーターに戻されます。次の表は、EAB および NOXLATE が設定されている場合に適用されます。

    ビット位置
    		意味
    0 反転イメージ

    0 = 標準イメージ

    1 = 反転イメージ

    1 下線

    0 = 下線なし

    1 = 下線付き

    2 明滅

    0 = 明滅しない

    1 = 明滅する

    3 桁分離文字線

    0 = 桁分離文字線なし

    1 = 桁分離文字線付き

    4 ～ 7 予約済み

    次の表は、パーソナル・コミュニケーションズの文字カラー属性を示します。次の表は、EAB および XLATE が設定されている場合に適用されます。

    ビット位置
    		意味
    0 ～ 3 背景文字の色

    0000 = 黒

    0001 = 青

    0010 = 緑

    0011 = シアン

    0100 = 赤

    0101 = マジェンタ

    0110 = 茶 (3270)、黄 (5250)

    0111 = 白

    4 ～ 7 前景文字の色

    0000 = 黒

    0001 = 青

    0010 = 緑

    0011 = シアン

    0100 = 赤

    0101 = マジェンタ

    0110 = 茶 (3270)、黄 (5250)

    0111 = 白

    1000 = 灰色

    1001 = 明るい青

    1010 = 明るい緑

    1011 = 明るいシアン

    1100 = 明るい赤

    1101 = 明るいマジェンタ

    1110 = 黄

    1111 = 白 (高輝度)

    PS/2(R) モノクローム表示の場合、アプリケーション (ワークステーション) セッション内の文字はグレー表示されます。この機能は、EHLLAPI アプリケーション・セッション内の再マップ済みの色をユーザーに提示して、ホストのアプリケーションの表示スペースに表示されているものを確認できるようにするために必要です。

  7. この関数を使用するには、戻りデータ・ストリング・パラメーターを受け入れるメモリーを事前に割り振ります。このメモリーの事前割り振りに必要なステートメントは、アプリケーションに使用される言語によって異なります。詳細については、メモリー割り振りを参照してください。
注:
5250 エミュレーションは、24 行 80 桁の表示スペースをサポートします。コミュニケーション・マネージャー 5250 エミュレーションが 25 番目の行を表示するインスタンスもあります。このようなことが起こるのは、ホストからのエラー・メッセージが表示される場合、またはオペレーターが SysReq キーを選択する場合です。パーソナル・コミュニケーションズは、25 行目の情報をステータス・バーに表示します。EXTEND_PS オプションを指定すると、EHLLAPI アプリケーションでコミュニケーション・マネージャー EHLLAPI と同じインターフェースを使用することができ、このような状況が発生した時に有効な表示スペースが拡張されます。

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

ユニコード・セッションでは、ホストのコピー元の表示スペース内の文字をユニコードに変換します。属性バイトは通常ブランクに変換されます。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 34 にしてください。
データ・ストリング 事前に割り振りされたターゲットのデータ・ストリング。拡張属性バイト (EAB) オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは少なくとも EBCDIC フィールドの長さの 2 倍必要です。
長さ ユニコード文字でのコピー先データ・ストリングの長さ。
PS 位置 該当フィールドを識別します。これはコピー先フィールド内のどのバイトの PS 位置でも構いません。コピー関数は常にフィールドの先頭から開始されます。

戻りパラメーター

この関数は、データ・ストリング、データ・ストリング長、戻りコードを戻します。

データ・ストリング:
ユニコード・データを含むストリングが戻されます。

データ・ストリング長:
ストリングにコピーされたユニコード文字の数。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Copy Field to String 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター指定でエラーが発生しました。
6 コピーするデータとコピー先フィールドのサイズが等しくありません。ストリングの長さがコピーされるフィールドよりも短い場合、データは切り捨てられます。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 ホスト表示スペースが定様式化されていません。

使用上の注意

以下のオプションは Copy Field To String (34) のユニコード・セッションでサポートされ、DBCS の場合と同じ方法で機能します。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

ユニコード・セッションでは、ホストのコピー元の表示スペース内の文字をユニコードに変換します。属性バイトは通常ブランクに変換されます。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 34 にしてください。
データ・ストリング 事前に割り振りされたターゲットのデータ・ストリング。長さは、表示スペースからコピーされる時に必要な EBCDIC バイト数の 2 倍必要です。拡張属性バイト (EAB) オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは少なくとも EBCDIC フィールドの長さの 4 倍必要です。
長さ コピー先データ・ストリングのバイト単位の長さ。この長さは、ユニコード・セッションでは最低 2 バイトなければなりません。そうでない場合は、2 のエラー・コードが戻されます。
PS 位置 該当フィールドを識別します。これはコピー先フィールド内のどのバイトの PS 位置でも構いません。コピー関数は常にフィールドの先頭から開始されます。

戻りパラメーター

この関数は、データ・ストリング、データ・ストリング長、戻りコードを戻します。

データ・ストリング:
ユニコード・データを含むストリングが戻されます。

データ・ストリング長:
ストリングにコピーされたユニコード文字の数。バイト数を知るには、2 を掛けます。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Copy Field to String 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター指定でエラーが発生しました。
6 コピーするデータとコピー先フィールドのサイズが等しくありません。ストリングの長さがコピーされるフィールドよりも短い場合、データは切り捨てられます。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 ホスト表示スペースが定様式化されていません。

使用上の注意

以下のオプションは Copy Field To String のユニコード・セッションでサポートされ、SBCS の場合と同じ方法で機能します。

Copy OIA (13)


3270 5250 VT
YES YES YES

Copy OIA 関数は、ホスト接続表示スペースから現在のオペレーター情報域 (OIA) データを戻します。

OIA は画面の下分割線の下側にあり、ワークステーションとホストとの接続に関するセッション状況情報の表示に使用されます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 13 にしてください。
データ・ストリング 事前に割り振りされたターゲットのデータ・ストリング
長さ 103 104
PS 位置 NA

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
16 ビットの場合は 103 バイトのストリング、32 ビットの場合は 104 バイトのストリング。詳細については、戻り OIA データ・ストリングの形式を参照してください。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 OIA データが戻されます。コピー先の表示スペースはロックされていません。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 指定されたストリング長に誤りがありました。 OIA データは戻されませんでした。
4 OIA データが戻されます。コピー先の表示スペースは使用中です。
5 OIA データが戻されます。コピー先の表示スペースはロックされています。 (入力禁止)
9 内部システム・エラーが発生しました。 OIA データは戻されませんでした。

使用上の注意

  1. OIA グループは、接続したセッションの状況を表すビットで構成されています。グループは、そのグループが意味するホストの関数によって分けられています。 (例えば、グループ 8 にはそのセッションで起こり得るすべての入力禁止条件を表すビットが入っています。) 各グループの状態は、高位のビットがより高い優先順位を表すような順序になっています。つまり、ビット 7 はビット 0 より優先されます。そのため、1 つのグループ内で複数の状態が活動状態にあるときは、優先順位の最も高い状態が、そのグループ内の活動状態です。
  2. この関数を使用するには、戻りデータ・ストリング・パラメーターを受け入れるメモリーを事前に割り振ります。このメモリーの事前割り振りに必要なステートメントは、アプリケーションに使用される言語によって異なります。詳細については、メモリー割り振りを参照してください。

戻り OIA データ・ストリングの形式

OIA データ・ストリングには以下の情報が入っています。

バイト位置 定義
標準 拡張  
1 1 OIA フォーマット設定バイト。値は 1 (PC/3270)、9 (PC400)、または 5 (VT) です。
2 ～ 81 2 ～ 81 ホスト・コード・ポイントの OIA イメージ。
82 ～ 103 82 ～ 103 OIA グループの標識の意味。
104 予約済み。

PC/3270 OIA グループの標識の意味とそのイメージ

OIA イメージ・グループは、ホスト・コード・ポイント内の OIA イメージを含む属性バイトのない 80 バイトの ASCII 文字ストリングから構成されます。図 2 は、ホスト表示スペースで検出される 16 進コードと、それらを表す文字を示しています。

戻されたデータは OIA グラフィックス文字に変換されます。 OIA 標識については、「はじめに」を参照してください。

戻されたデータを OIA グラフィックス文字に変換する場合は次のようにします。

  1. バイト 2 から 81 に戻されたデータを、画面またはプリンターで表示または印刷します。
  2. 出力が表示される装置に適用できるコード・ページ・チャートを使用して、それぞれの文字に対応する 16 進数値を見つけます。
  3. 図 2 を使用して、ステップ 2 で見つけた 16 進数値のそれぞれに対応する OIA グラフィックス文字を見つけます。

注:
グループ 8 (バイト 0) 機械チェック、通信チェック、およびプログラム・チェックのイメージの後には、チェックのタイプに関連する 3 桁の数字があります。

オンラインおよび表示画面の所有権グループのイメージは非 SNA 3274 コントローラー構成のためのものです。SNA の場合、16 進数値 CD は CD (図 2 を参照) に変換されます。3174 コントローラーまたは SDLC 接続での実行の場合、16 進数値 X'F4' は X'B2' または X'22' に置き換えられます。強調表示標識は、"グループ 5 (オフセット 86 強調表示グループ 1" のバイト) に対応する (データ・ストリングの先頭 80 バイトの中にある) イメージです。強調表示標識の後には、X'F9' (明滅)、X'FC' (下線)、 X'D2' (反転表示)、または X'80' (ホスト・デフォルト値) のいずれかが続きます。

後に X'20' が続く短縮セッション ID は 7 桁目にあります。

すべてのグループ・イメージは、メインフレーム・インタラクティブ (MFI) の 16 進コード・ポイントで表されます。

注:
OIA イメージ・データ・ストリング位置から 1 を引いたものが、OIA 桁に等しくなります。

図 2. ホスト表示スペース文字

REQTEXT

PC400 OIA グループの標識の意味とそのイメージ

以下の表に、OIA グループの詳細をリストします。

VT ホスト OIA グループの標識の意味とそのイメージ

以下の表に、VT ホスト OIA グループの詳細をリストします。

OIA 行表示の一部の桁には、3270/5250 用に表示されるメッセージとは異なる VT 用のメッセージが表示されます。個々の詳細については次の表を参照してください。


桁 シンボル
1 ～ 7 VT220 7
VT220 8
VT100
VT52
VTANSI
9 ～ 12 LOCK
61 ～ 64 HOLD

Copy Presentation Space (5)


3270 5250 VT
YES YES YES

Copy Presentation Space 関数は、ホスト接続した表示スペースの内容を EHLLAPI アプリケーション・プログラム内に定義されたデータ・ストリングにコピーします。

Copy Presentation Space 関数は、ホストのコピー元の表示スペース内の文字を ASCII 形式に変換します。属性バイトやその他の通常 ASCII では表されない文字は、ブランクに変換されます。属性バイトをブランクに変換したくない場合には、Set Session Parameters (9) 関数の ATTRB オプションを指定して、この変換を一時変更することができます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 5 にしてください。
データ・ストリング 事前にホスト表示スペースのサイズを割り振られたコピー先ストリング。このサイズはホスト表示スペースの構成によって違います。 EAB オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは少なくとも表示スペースの長さの 2 倍必要です。

DBCS の場合のみ: EAD オプションを指定した場合、データ・ストリングの長さは少なくとも表示スペースの長さの 3 倍必要です。 EAB と EAD の両オプションを指定した場合、データ・ストリングの長さは最低でも表示スペースの長さの 4 倍なければなりません。

長さ NA (ホスト表示スペース長が暗黙指定されます)。
PS 位置 NA

戻りパラメーター

この関数は、データ・ストリング、データ・ストリング長、戻りコードを戻します。

データ・ストリング:
接続されたホスト表示スペースの内容。

データ・ストリング長:
コピーされたデータの長さ。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 ホスト表示スペースの内容はアプリケーション・プログラムにコピーされました。コピー先表示スペースは活動状態にあり、キーボードはアンロックされています。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
4 ホスト表示スペースの内容はコピーされました。接続されたホスト表示スペースはホストからの応答を待っています。
5 ホスト表示スペースはコピーされました。キーボードはロックされています。
9 システム・エラーが発生しました。

使用上の注意

  1. EAB を戻すには、Set Session Parameters (9) 関数の EAB オプションを使用します。EAB は表示スペース上の各文字と関連しており、それぞれの文字の前に戻されます。
  2. DBCS の場合のみ: Set Session Parameters (9) 関数の EAD オプションをこの関数と共に使用して、2 バイトの EAD を戻すことができます。EAB オプションを指定せずに EAD オプションを指定した場合、各文字の前に EAD が戻されます。EAB と EAD の両オプションを指定した場合、EAB の前に EAD が戻されます。

    コピーの開始位置が 2 バイト文字の第 2 バイトである場合、または終了位置が 2 バイト文字の第 1 バイトである場合、これらのバイトはブランクに変換されます。

  3. Copy Presentation Space 関数は以下のセッション・オプションの影響を受けます。

詳細については、5、 13、 14、 15、 17、 20、および 21 を参照してください。

提供されたコピー先データ・ストリングが、要求データを保持するための十分な長さがない場合は、予測できない結果となる可能性があります。

前述のように、さまざまな Copy (5、8、および 34) 関数により戻される属性は、Set Session Parameters (9) 関数の影響を受けます。関係するセッション設定パラメーターは、以下のような影響を及ぼします。

セッション設定パラメーター
COPY 機能への影響

NOEAB、NOEAD
属性は戻されません。テキストのみを表示スペースからユーザーのバッファーへコピーします。

EAB、NOXLATE
属性は以下の表に定義されたとおりに戻されます。

EAB、XLATE
表示スペースの表示に使用される色が戻されます。色は再マップできるので、XLATE と EAB が同時に ON になっている場合、属性の色は Copy 関数によって戻される色ではありません。

EAD
以下の表に示される 2 バイト文字セット属性が戻されます。

NOSO/SPACESO/SO
NOSO を指定した場合、SPACESO として機能します。表示スペースのサイズは変わりません。

戻される文字の属性を以下の表に示します。属性ビット位置は IBM 形式 (つまり、バイトの左端がビット 0) で示してあります。

3270 の文字属性が、ホストからエミュレーターに戻されます。次の表は、EAB および NOXLATE が設定されている場合に適用されます。

ビット位置 意味
0 ～ 1 文字の強調表示

00 = 標準

01 = 明滅

10 = 反転表示

11 = 下線

2 ～ 4 文字の色 (カラー再マップでこの色定義を一時変更できます。)

000 = デフォルト値

001 = 青

010 = 赤

011 = ピンク

100 = 緑

101 = 空色

110 = 黄

111 = 白

5 ～ 6 文字属性

00 = デフォルト値

11 = 2 バイト文字

7 予約済み

5250 の文字属性が、ホストからエミュレーターに戻されます。次の表は、EAB および NOXLATE が設定されている場合に適用されます。

ビット位置 意味
0 反転イメージ

0 = 標準イメージ

1 = 反転イメージ

1 下線

0 = 下線なし

1 = 下線付き

2 明滅

0 = 明滅しない

1 = 明滅する

3 桁分離文字線

0 = 桁分離文字線なし

1 = 桁分離文字線付き

4 ～ 7 予約済み

次の表は、パーソナル・コミュニケーションズの文字カラー属性を示します。次の表は、EAB および XLATE が設定されている場合に適用されます。

ビット位置 意味
0 ～ 3 背景文字の色

0000 = 黒

0001 = 青

0010 = 緑

0011 = シアン

0100 = 赤

0101 = マジェンタ

0110 = 茶 (3270)、黄 (5250)

0111 = 白

4 ～ 7 前景文字の色

0000 = 黒

0001 = 青

0010 = 緑

0011 = シアン

0100 = 赤

0101 = マジェンタ

0110 = 茶 (3270)、黄 (5250)

0111 = 白

1000 = 灰色

1001 = 明るい青

1010 = 明るい緑

1011 = 明るいシアン

1100 = 明るい赤

1101 = 明るいマジェンタ

1110 = 黄

1111 = 白 (高輝度)

PS/2 モノクローム表示の場合、アプリケーション (ワークステーション) セッション内の文字はグレー表示されます。この機能は、EHLLAPI アプリケーション・セッション内の再マップ済みの色をユーザーに提示して、ホストのアプリケーションの表示スペースに表示されているものを確認できるようにするために必要です。

ホスト表示スペースの一部のみをコピーしたい場合は、Copy Presentation Space to String (8) 関数を使用します。

この関数を使用するには、戻りデータ・ストリング・パラメーターを受け入れるメモリーを事前に割り振ります。このメモリーの事前割り振りに必要なステートメントは、アプリケーションに使用される言語によって異なります。詳細については、メモリー割り振りを参照してください。

注:
5250 エミュレーションは、24 行 80 桁の表示スペースをサポートします。コミュニケーション・マネージャー 5250 エミュレーションが 25 番目の行を表示するインスタンスもあります。このようなことが起こるのは、ホストからのエラー・メッセージが表示される場合、またはオペレーターが SysReq キーを選択する場合です。パーソナル・コミュニケーションズは、25 行目の情報を 24 行目またはステータス・バーに表示します。ステータス・バーに情報が表示される場合は、ステータス・バーがその情報用に構成されている必要があります。ステータス・バーの構成方法の詳細については、「はじめに」を参照してください。EXTEND_PS オプションによって、EHLLAPI アプリケーションはコミュニケーション・マネージャー EHLLAPI と同じインターフェースを使用することができ、このような状況が発生したときに有効な表示スペースが拡張されます。

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

ユニコード・セッションでは、ホストのコピー元の表示スペース内の文字をユニコードに変換します。属性バイトは通常ブランクに変換されます。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters (9) 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 5 にしてください。
データ・ストリング 事前に割り振られたコピー先ユニコード・ストリング。拡張属性バイト (EAB) オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは少なくとも表示スペースのサイズの 2 倍必要です。
長さ NA (ホスト表示スペース長が暗黙指定されます)。
PS 位置 NA

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
表示スペースの内容のユニコード・プレゼンテーションを含むストリングが戻されます。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 ホスト表示スペースの内容はアプリケーション・プログラムにコピーされました。コピー先表示スペースは活動状態にあり、キーボードはアンロックされています。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
4 ホスト表示スペースの内容はコピーされました。接続されたホスト表示スペースはホストからの応答を待っています。
5 ホスト表示スペースはコピーされました。キーボードはロックされています。
9 システム・エラーが発生しました。

使用上の注意

以下のオプションは Copy Presentation Space (5) のユニコード・セッションでサポートされ、DBCS の場合と同じ方法で機能します。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

ユニコード・セッションでは、ホストのコピー元の表示スペース内の文字をユニコードに変換します。属性バイトは通常ブランクに変換されます。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters (9) 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 5 にしてください。
データ・ストリング 事前に割り振られたコピー先ユニコード・データ・ストリング。長さ (バイトで) は、表示スペースのサイズの 2 倍 (バイトで) 必要です。拡張属性バイト (EAB) オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは少なくとも表示スペースのサイズの 4 倍必要です。
長さ NA (ホスト表示スペース長が暗黙指定されます)。
PS 位置 NA

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
表示スペースの内容のユニコード・プレゼンテーションを含むストリングが戻されます。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 ホスト表示スペースの内容はアプリケーション・プログラムにコピーされました。コピー先表示スペースは活動状態にあり、キーボードはアンロックされています。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
4 ホスト表示スペースの内容はコピーされました。接続されたホスト表示スペースはホストからの応答を待っています。
5 ホスト表示スペースはコピーされました。キーボードはロックされています。
9 システム・エラーが発生しました。

使用上の注意

以下のオプションは Copy Presentation Space (5) のユニコード・セッションでサポートされ、DBCS の場合と同じ方法で機能します。

Copy Presentation Space to String (8)


3270 5250 VT
YES YES YES

Copy Presentation Space to String 関数は、ホスト接続表示スペースのすべてまたは一部を、EHLLAPI アプリケーション・プログラム内に定義したデータ・ストリングにコピーする場合に使用します。

入力 PS 位置は、ホストの表示スペースのオフセットです。このオフセットは、左上隅 (行 1、桁 1) を位置 1、右下隅を 3564 (ホスト表示スペースの最大表示画面サイズ) とするレイアウトを基にしています。 PS 位置 + (長さ - 1) の値は、ホスト表示スペースの構成サイズを超えることはできません。

Copy Presentation Space to String 関数はホストのコピー元の表示スペース内の文字を ASCII 形式に変換します。属性バイトやその他の通常 ASCII では表されない文字は、ブランクに変換されます。属性バイトをブランクに変換したくない場合には、Set Session Parameters (9) 関数の ATTRB オプションを指定して、この変換を一時変更することができます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 8 にしてください。
データ・ストリング 事前にホスト表示スペースのサイズを割り振られたコピー先ストリング。 EAB オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは少なくとも表示スペースの長さの 2 倍必要です。

DBCS の場合のみ: EAD オプションを指定した場合、データ・ストリングの長さは少なくとも表示スペースの長さの 3 倍必要です。 EAB と EAD の両オプションを指定した場合、データ・ストリングの長さは最低でも表示スペースの長さの 4 倍なければなりません。

長さ 該当データ・ストリングの長さ。
PS 位置 コピー先データ・ストリングの第 1 バイトのホスト表示スペース内の位置。

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
ホスト表示スペースの内容。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 ホスト表示スペースの内容はアプリケーション・プログラムにコピーされました。コピー先表示スペースは活動状態にあり、キーボードはアンロックされています。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 指定されたストリング長に誤りがありました。あるいは、 (データ・ストリング長 - 1) + PS 位置の合計が、接続されているホスト表示スペースのサイズを超えています。
4 ホスト表示スペースの内容はコピーされました。ホスト表示スペースはホストの応答を待っています。
5 ホスト表示スペースはコピーされました。キーボードはロックされています。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。

使用上の注意

  1. EAB を戻すには、Set Session Parameters (9) 関数の EAB オプションを使用します。EAB は表示スペースの各文字と関連しており、それぞれの文字の後に戻されます。
  2. DBCS の場合のみ: Set Session Parameters (9) 関数の EAD オプションをこの関数と共に使用して、2 バイトの EAD を戻すことができます。EAB オプションを指定せずに EAD オプションを指定した場合、各文字の前に EAD が戻されます。EAB と EAD の両オプションを指定した場合、EAB の後に EAD が戻されます。

    コピーの開始位置が 2 バイト文字の第 2 バイトである場合、または終了位置が 2 バイト文字の第 1 バイトである場合、これらのバイトはブランクに変換されます。EAD オプションを ON に設定した場合、1 文字につき 3 バイトずつ戻されます。EAB と EAD の両オプションを ON に設定した場合は、1 文字につき 4 バイトずつ戻されます。

  3. Copy Presentation Space to String 関数は以下のオプションの影響を受けます。 詳細については、5、 13、 14、 15、 17、 20 および 21 を参照してください。

    指定されたコピー先のデータ・ストリングが要求されたバイト数を保持するのに十分でない場合、コピー先データ・ストリングの終わりに達した時にコピー関数は正常終了します (RC=0、4、または 5)。

    前述のように、さまざまな Copy (5、8、および 34) 関数により戻される属性は、Set Session Parameters (9) 関数の影響を受けます。関係するセッション設定パラメーターは、以下のような影響を及ぼします。

    セッション設定パラメーター
    Copy 機能への影響

    NOEAB、NOEAD
    属性は戻されません。テキストのみを表示スペースからユーザーのバッファーへコピーします。

    EAB、NOXLATE
    属性は以下の表に定義されたとおりに戻されます。

    EAB、XLATE
    表示スペースの表示に使用される色が戻されます。色は再マップできるので、XLATE と EAB が同時に ON になっている場合、属性の色は Copy 関数によって戻される色ではありません。

    EAD
    以下の表に示される 2 バイト文字セット属性が戻されます。

    戻される文字の属性を以下の表に示します。属性ビット位置は IBM 形式 (つまり、バイトの左端がビット 0) で示してあります。


    ビット位置
    		意味
    0 ～ 1 文字の強調表示

    00 = 標準

    01 = 明滅

    10 = 反転表示

    11 = 下線

    2 ～ 4 文字の色 (カラー再マップでこの色定義を一時変更できます。)

    000 = デフォルト値

    001 = 青

    010 = 赤

    011 = ピンク

    100 = 緑

    101 = 空色

    110 = 黄

    111 = 白

    5 ～ 7 予約済み


    ビット位置
    		意味
    0 反転イメージ

    0 = 標準イメージ

    1 = 反転イメージ

    1 下線

    0 = 下線なし

    1 = 下線付き

    2 明滅

    0 = 明滅しない

    1 = 明滅する

    3 桁分離文字線

    0 = 桁分離文字線なし

    1 = 桁分離文字線付き

    4 ～ 7 予約済み


    ビット位置
    		意味
    0 ～ 3 予約済み
    4 Bold

    1 = オン

    0 = オフ

    5 下線

    1 = オン

    1 = オフ

    6 明滅

    1 = オン

    0 = オフ

    7 反転表示

    0 = オン

    1 = オフ


    ビット位置
    		意味
    0 ～ 3 背景文字の色

    0000 = 黒

    0001 = 青

    0010 = 緑

    0011 = シアン

    0100 = 赤

    0101 = マジェンタ

    0110 = 茶 (3270)、黄 (5250)

    0111 = 白

    4 ～ 7 前景文字の色

    0000 = 黒

    0001 = 青

    0010 = 緑

    0011 = シアン

    0100 = 赤

    0101 = マジェンタ

    0110 = 茶 (3270)、黄 (5250)

    0111 = 白

    1000 = 灰色

    1001 = 明るい青

    1010 = 明るい緑

    1011 = 明るいシアン

    1100 = 明るい赤

    1101 = 明るいマジェンタ

    1110 = 黄

    1111 = 白 (高輝度)

    PS/2 モノクローム表示の場合、アプリケーション (ワークステーション) セッション内の文字はグレー表示されます。この機能は、EHLLAPI アプリケーション・セッション内の再マップ済みの色をユーザーに提示して、ホストのアプリケーションの表示スペースに表示されているものを確認できるようにするために必要です。

  4. この関数を使用するには、戻りデータ・ストリング・パラメーターを受け入れるメモリーを事前に割り振ります。このメモリーの事前割り振りに必要なステートメントは、アプリケーションに使用される言語によって異なります。詳細については、メモリー割り振りを参照してください。
注:
5250 エミュレーションは、24 行 80 桁の表示スペースをサポートします。コミュニケーション・マネージャー 5250 エミュレーションが 25 番目の行を表示するインスタンスもあります。このようなことが起こるのは、ホストからのエラー・メッセージが表示される場合、またはオペレーターが SysReq キーを選択する場合です。パーソナル・コミュニケーションズは、25 行目の情報を 24 行目またはステータス・バーに表示します。ステータス・バーに情報が表示される場合は、ステータス・バーがその情報用に構成されている必要があります。ステータス・バーの構成方法の詳細については、「はじめに」を参照してください。EXTEND_PS オプションによって、EHLLAPI アプリケーションはコミュニケーション・マネージャー EHLLAPI と同じインターフェースを使用することができ、このような状況が発生したときに有効な表示スペースが拡張されます。

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

ユニコード・セッションでは、ホストのコピー元の表示スペース内の文字をユニコードに変換します。属性バイトは通常ブランクに変換されます。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters (9) 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 8 にしてください。
データ・ストリング 事前に割り振られたコピー先ユニコード・ストリング。拡張属性バイト (EAB) オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは少なくとも表示スペースの長さの 2 倍必要です。
長さ ユニコード文字でのコピー先ユニコード・ストリングの長さ。
PS 位置 コピー先データ・ストリングの第 1 バイトのホスト表示スペース内の位置。

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
ユニコード・データを含むストリングが戻されます。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 ホスト表示スペースの内容はアプリケーション・プログラムにコピーされました。コピー先表示スペースは活動状態にあり、キーボードはアンロックされています。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 指定されたストリング長に誤りがありました。あるいは、 (データ・ストリング長 - 1) + PS 位置の合計が、接続されているホスト表示スペースのサイズを超えています。
4 ホスト表示スペースの内容はコピーされました。ホスト表示スペースはホストの応答を待っています。
5 ホスト表示スペースはコピーされました。キーボードはロックされています。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。

使用上の注意

以下のオプションは Copy Presentation Space to String のユニコード・セッションでサポートされ、DBCS の場合と同じ方法で機能します。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

ユニコード・セッションでは、ホストのコピー元の表示スペース内の文字をユニコードに変換します。属性バイトは通常ブランクに変換されます。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters (9) 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 8 にしてください。
データ・ストリング 事前に割り振りされたターゲットのデータ・ストリング。長さは、表示スペースからコピーされる時に必要な EBCDIC バイト数の少なくとも 2 倍必要です。拡張属性バイト (EAB) オプションを指定して Set Session Parameters (9) 関数を発行した場合、データ・ストリングの長さは表示スペースからコピーされる EBCDIC ストリングの長さの少なくとも 4 倍必要です。
長さ コピー先ユニコード・ストリングのバイト単位の長さ。この長さは、ユニコード・セッションでは最低 2 バイトなければなりません。そうでない場合は、2 のエラー・コードが戻されます。
PS 位置 コピー先データ・ストリングの第 1 バイトのホスト表示スペース内の位置。

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
ホスト表示スペースの内容。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 ホスト表示スペースの内容はアプリケーション・プログラムにコピーされました。コピー先表示スペースは活動状態にあり、キーボードはアンロックされています。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 指定されたストリング長に誤りがありました。あるいは、 (データ・ストリング長 - 1) + PS 位置の合計が、接続されているホスト表示スペースのサイズを超えています。
4 ホスト表示スペースの内容はコピーされました。ホスト表示スペースはホストの応答を待っています。
5 ホスト表示スペースはコピーされました。キーボードはロックされています。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。

使用上の注意

以下のオプションは Copy Presentation Space to String のユニコード・セッションでサポートされ、SBCS の場合と同じ方法で機能します。

Copy String to Field (33)


3270 5250 VT
YES YES YES

Copy String to Field 関数は、文字ストリングをホスト接続表示スペース内の指定したフィールドへ転送します。この関数は、フィールド形式 のホスト表示スペースでのみ使用できます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 33 にしてください。
データ・ストリング ホスト表示スペース内のコピー先フィールドへ転送するデータが入っているストリング。
長さ コピー元データ・ストリングの長さ (バイト数)。 EOT モードの場合、このパラメーターは一時変更されます。
PS 位置 該当フィールドを識別します。これはコピー先フィールド内のどのバイトの PS 位置でも構いません。コピー関数は常にフィールドの先頭から開始されます。

戻りパラメーター


戻りコード 説明
0 Copy String to Field 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーターが誤っているか、パラメーター長 0 がコピーに指定されました。
5 コピー先フィールドが保護または入力禁止になっているか、あるいは、無効なデータ (フィールド属性など) がコピー先フィールドに送られました。
6 コピーは完了しましたが、データが切り捨てられました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 ホスト表示スペースが定様式化されていません。

使用上の注意

  1. Copy String to Field 関数は次のオプションの影響を受けます。

    詳細については、1 と 2、13、14、18、 20 および 21 を参照してください。

  2. 転送するストリングは、呼び出しデータ・ストリング・パラメーターで指定します。次のいずれかの状況が発生したとき、ストリングは終了します。

    注:
    フィールドがホスト表示スペースの終わりで折り返している場合、表示スペースの終わりに到達したときに折り返します。
  3. キーボードの略号 (Send Key (3) 関数を参照) は、 Copy String to Field 関数を使用して送信することはできません。
  4. 転送されるデータの第 1 バイトは、常に、指定した PS 位置を含むフィールドの先頭に置かれます。
  5. DBCS の場合のみ: ストリングに 2 バイト文字を含めることができます。

    注:
    PC400 は、ストリングに SO および SI を追加しません。 DBCS 混用フィールドに 2 バイト文字を含むストリングを書き込む場合は、事前に Send Key (3) 関数を使用して、SO および SI を生成し、2 バイト文字を書き込むための区域を作成しておいてください。

    1 つのストリング内に 1 バイト文字と 2 バイト文字が存在する場合、EBCDIC で作成されたデータの方が ASCII で作成されたデータよりも長いので、データが切り捨てられることがあります。このような場合、2 バイト文字の第 1 バイトまたは第 2 バイトだけを書き込むことはしません。

    コピー元ストリングの最後の文字が 2 バイト文字の第 1 バイトである場合、その文字は書き込まれず、長さに加算されません。

    制御文字は、フィールドの状況に応じて、1 バイト文字から 2 バイト文字へ、または 2 バイト文字から 1 バイト文字へ変換されます。 SO と SI の間にある NULL+ 制御文字の対は、1 つの 2 バイト制御文字として扱われます。例えば、以下のストリングは、1 バイト文字フィールドまたは 2 バイト文字フィールドへ、それぞれ表に示されるようにコピーされます。


      ストリング   意味 1 バイト文字フィールド 2 バイト文字フィールド
    X'000C' (NULL)(FF) X'00'X'0C' (SB NULL)(SB FF) X'00'X'0C' (DB NULL)(DB FF) X'0000'X'000C'
    X'0E000C0F' (SO)(DB FF)(SI) X'0E'X'000C'X'0F' -S エラー (DB FF) X'000C'
    注:
    SB は 1 バイト文字、DB は 2 バイト文字を意味します。
注:
5250 エミュレーションは、24 行 80 桁の表示スペースをサポートします。コミュニケーション・マネージャー 5250 エミュレーションが 25 番目の行を表示するインスタンスもあります。このようなことが起こるのは、ホストからのエラー・メッセージが表示される場合、またはオペレーターが SysReq キーを選択する場合です。パーソナル・コミュニケーションズは、25 行目の情報を 24 行目またはステータス・バーに表示します。ステータス・バーに情報が表示される場合は、ステータス・バーがその情報用に構成されている必要があります。ステータス・バーの構成方法の詳細については、「はじめに」を参照してください。EXTEND_PS オプションによって、EHLLAPI アプリケーションはコミュニケーション・マネージャー EHLLAPI と同じインターフェースを使用することができ、このような状況が発生したときに有効な表示スペースが拡張されます。

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters (9) 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 33 にしてください。
データ・ストリング ホスト表示スペース内のコピー先フィールドへ転送するユニコード・データが入っているストリング。
長さ コピー元ユニコード・ストリングの長さ (ユニコード文字数)。

注:
EOT モードはユニコード・セッションではサポートされていません。したがって、ユニコード・セッションでこの関数が正しく機能するように長さを指定する必要があります。
PS 位置 該当フィールドを識別します。これはコピー先フィールド内のどのバイトの PS 位置でも構いません。コピー関数は常にフィールドの先頭から開始されます。

戻りパラメーター

戻りコード 説明
0 Copy String to Field 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーターが誤っているか、パラメーター長 0 がコピーに指定されました。
5 コピー先フィールドが保護または入力禁止になっているか、あるいは、無効なデータ (フィールド属性など) がコピー先フィールドに送られました。
6 コピーは完了しましたが、データが切り捨てられました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 ホスト表示スペースが定様式化されていません。

使用上の注意

以下のオプションは Copy String to Field のユニコード・セッションでサポートされ、DBCS の場合と同じ方法で機能します。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters (9) 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 33 にしてください。
データ・ストリング ホスト表示スペース内のコピー先フィールドへ転送するユニコード・データが入っているストリング。
長さ コピー元ユニコード・ストリングの長さ (バイト数)。長さは、最低 2 バイトでなければなりません。そうでない場合は、2 のエラー・コードが戻されます。

注:
EOT モードはユニコード・セッションではサポートされていません。したがって、ユニコード・セッションでこの関数が正しく機能するように長さを指定する必要があります。
PS 位置 該当フィールドを識別します。これはコピー先フィールド内のどのバイトの PS 位置でも構いません。コピー関数は常にフィールドの先頭から開始されます。

戻りパラメーター

戻りコード 説明
0 Copy String to Field 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーターが誤っているか、パラメーター長 0 がコピーに指定されました。
5 コピー先フィールドが保護または入力禁止になっているか、あるいは、無効なデータ (フィールド属性など) がコピー先フィールドに送られました。
6 コピーは完了しましたが、データが切り捨てられました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 ホスト表示スペースが定様式化されていません。

使用上の注意

以下のオプションは Copy String to Field のユニコード・セッションでサポートされ、SBCS の場合と同じ方法で機能します。

Copy String to Presentation Space (15)


3270 5250 VT
YES YES YES

Copy String to Presentation Space 関数は、ASCII データ・ストリングをホスト表示スペースの PS 位置呼び出しパラメーターで指定した位置に、直接コピーします。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター



標準インターフェース 拡張インターフェース
関数番号 必ず 15 にしてください。
データ・ストリング ホスト表示スペースにコピーする ASCII データ・ストリング。
長さ コピー元データ・ストリングの長さ (バイト数)。 EOT モードの場合、このパラメーターは一時変更されます。
PS 位置 コピーを開始するホスト表示スペースの位置。 1 とホスト表示スペースの構成サイズの間の値です。

戻りパラメーター


戻りコード 説明
0 Copy String to Presentation Space 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーターが誤っているか、パラメーター長 0 がコピーに指定されました。
5 コピー先表示スペースが保護または入力禁止になっているか、あるいは、無効なデータがコピー先表示スペースに送られました (フィールド属性バイトなど)。
6 コピーは完了しましたが、データが切り捨てられました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。

使用上の注意

  1. Copy String to Presentation Space 関数は以下のオプションの影響を受けます。 詳細については、1 と 2、 13 と 14 、18、および 20 と 21 を参照してください。

  2. キーボードの略号 (Send Key (3) 関数を参照) は、Copy String to Presentation Space 関数を使用して送信することはできません。
  3. Set Session Parameters (9) 関数を使用して EOT モードを選択した場合、テキスト終了 (EOT) 区切り文字が検出されると、ストリングが終了します (Set Session Parameters (9)を参照してください)。
  4. Send Key (3) 関数も同じ目的を果たしますが、この関数の方がプロンプトを使って応答し、コマンド入力が迅速です。 Send Key (3) 関数はデータをキーボードからタイプする端末オペレーターをエミュレートするので、大量のデータを操作するアプリケーションでは処理速度が遅くなります。 Copy String to Presentation Space 関数は、ホストに対するより迅速な入力パスを提供します。
  5. コピー元データ (コピーされるストリング) は、表示スペースのサイズを超えることはできません。
  6. DBCS の場合のみ: ストリングに 2 バイト文字を含めることができます。

    注:
    PC400 は、ストリングに SO および SI を追加しません。 DBCS 混用フィールドに 2 バイト文字を含むストリングを書き込む場合は、事前に Send Key (3) 関数を使用して、SO および SI を生成し、2 バイト文字を書き込むための区域を作成しておいてください。

    1 つのストリング内に 1 バイト文字と 2 バイト文字が存在する場合、EBCDIC で作成されたデータの方が ASCII で作成されたデータよりも長いので、データが切り捨てられることがあります。 2 バイト文字の第 1 バイトまたは第 2 バイトだけをストリングに書き込む必要がある場合には、ブランクが書き込まれます。

    コピー元ストリングの最後の文字が 2 バイト文字の第 1 バイトである場合、その文字は書き込まれず、長さに加算されません。

    コピー先表示スペースの最後の文字として書き込まれる文字が SO/SI であるか、または 2 バイト文字の第 1 バイトである場合、その文字は書き込まれず、切り捨てられ、長さに加算されません。

    制御文字は、フィールドの状況に応じて、1 バイト文字から 2 バイト文字へ、または 2 バイト文字から 1 バイト文字へ変換されます。 SO と SI の間にある NULL+ 制御文字の対は、1 つの 2 バイト制御文字として扱われます。例えば、以下のストリングは、1 バイト文字フィールドまたは 2 バイト文字フィールドへ、それぞれ表に示されるようにコピーされます。


      ストリング   意味 1 バイト文字フィールド 2 バイト文字フィールド
    X'000C' (NULL)(FF) X'00'X'0C' (SB NULL)(SB FF) X'00'X'0C' (DB NULL)(DB FF) X'0000'X'000C'
    X'0E000C0F' (SO)(DB FF)(SI) X'0E'X'000C'X'0F' -S エラー (DB FF) X'000C'
    注:
    SB は 1 バイト文字、DB は 2 バイト文字を意味します。

    注:
    5250 エミュレーションは、24 行 80 桁の表示スペースをサポートします。コミュニケーション・マネージャー 5250 エミュレーションが 25 番目の行を表示するインスタンスもあります。このようなことが起こるのは、ホストからのエラー・メッセージが表示される場合、またはオペレーターが SysReq キーを選択する場合です。パーソナル・コミュニケーションズ は、 24 行目に常に同じ情報を表示します。EXTEND_PS オプションによって、EHLLAPI アプリケーションはコミュニケーション・マネージャー EHLLAPI と同じインターフェースを使用することができ、このような状況が発生したときに有効な表示スペースが拡張されます。
  7. 一部のホスト・アプリケーションでは、この関数呼び出しにより、予期せぬ位置にカーソルが移動することがあります。フィールドへの書き込みに関しては、この関数よりも、 SendKey 関数を使用する方が良い選択です。

    注:
    このことが生じるのは、VT セッションの場合や、ASCII ホストに接続する場合だけです。

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters (9) 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 15 にしてください。
データ・ストリング ホスト表示スペースに転送するユニコード・データが入っているストリング。
長さ コピー元ユニコード・ストリングの長さ (ユニコード文字数)。

注:
EOT モードはユニコード・セッションではサポートされていません。したがって、ユニコード・セッションでこの関数が正しく機能するように長さを指定する必要があります。
PS 位置 コピーを開始するホスト表示スペースの位置。 1 とホスト表示スペースの構成サイズの間の値です。

戻りパラメーター

戻りコード 説明
0 Copy String to Presentation Space 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーターが誤っているか、パラメーター長 0 がコピーに指定されました。
5 コピー先表示スペースが保護または入力禁止になっているか、あるいは、無効なデータがコピー先表示スペースに送られました (フィールド属性バイトなど)。
6 コピーは完了しましたが、データが切り捨てられました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。

使用上の注意

以下のオプションは Copy String to Presentation Space のユニコード・セッションでサポートされ、DBCS の場合と同じ方法で機能します。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

ユニコード・セッションでは、 XLATE オプション (Set Session Parameters (9) 関数を使用して指定できる) はサポートされていません。これは、もしこのオプションが発行されても、EAB は PC カラー・グラフィックス・アダプター (CGA) 形式に変換されないことを意味します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 15 にしてください。
データ・ストリング ホスト表示スペースに転送するユニコード・データが入っているストリング。
長さ コピー元ユニコード・ストリングの長さ (ユニコード文字数)。長さは、最低 2 バイトでなければなりません。そうでない場合は、2 のエラー・コードが戻されます。

注:
EOT モードはユニコード・セッションではサポートされていません。したがって、ユニコード・セッションでこの関数が正しく機能するように長さを指定する必要があります。
PS 位置 コピーを開始するホスト表示スペースの位置。 1 とホスト表示スペースの構成サイズの間の値です。

戻りパラメーター

戻りコード 説明
0 Copy String to Presentation Space 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーターが誤っているか、パラメーター長 0 がコピーに指定されました。
5 コピー先表示スペースが保護または入力禁止になっているか、あるいは、無効なデータがコピー先表示スペースに送られました (フィールド属性バイトなど)。
6 コピーは完了しましたが、データが切り捨てられました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。

使用上の注意

以下のオプションは Copy String to Presentation Space のユニコード・セッションでサポートされ、SBCS の場合と同じ方法で機能します。

Disconnect from Structured Fields (121)


3270 5250 VT
YES NO NO

Disconnect from Structured Fields 関数は、エミュレーション・プログラムと EHLLAPI アプリケーションの間の接続を切断します。システムで終了する前に、EHLLAPI アプリケーションをエミュレーション・プログラムから切断する必要があります。以前に Connect for Structured Fields が発行されている場合には、EHLLAPI アプリケーションでこの関数要求を発行する必要があります。

Reset System (21) 関数も未処理の SF 接続を切断します。

前提呼び出し

Connect for Structured Fields (120)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 121 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 3 にしてください。 必ず 8 にしてください。
PS 位置 NA

データ・ストリングの内容


バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 4 予約済み。
2 ～ 3 5 ～ 6 Connect for structured field (120) 関数が戻す固有の Destination/Origin ID
7 ～ 8 予約済み。

戻りパラメーター


戻りコード 説明
0 Disconnect from Structured Fields 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
40 アプリケーションは非同期要求が保留のまま切断されました。

使用上の注意

  1. Disconnect from Structured Fields 関数が呼び出された時点で、アプリケーションが Get Request Completion (125) 関数呼び出しを発行すると、非同期の Read Structured Fields (126) や Write Structured Fields (127) の関数要求の未処理のものはどれも戻されます。切断呼び出しを発行した後で実行取り消しする場合は、この関数の非同期形式を使用してください。
  2. Reset System (21) 関数も未処理の非同期要求 (Get Request Completion (125) 関数をアプリケーションが検索できなかった要求) を解放します。

Disconnect Presentation Space (2)


3270 5250 VT
YES YES YES

Disconnect Presentation Space 関数は、EHLLAPI アプリケーション・プログラムとホスト表示スペースの間の接続を切断します。また、Reserve (11) 関数によりホスト表示スペースが予約済みの場合、それは Disconnect Presentation Space 関数の実行時に解放されます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 2 にしてください。
データ・ストリング NA
長さ NA
PS 位置 NA

戻りパラメーター


戻りコード 説明
0 Disconnect Presentation Space 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト表示スペースに接続されていません。
9 システム・エラーが発生しました。

使用上の注意

  1. Disconnect Presentation Space 関数が呼び出されると、ホスト接続表示スペースと対話する関数 (Send Key (3)、Wait (4)、 Reserve (11) および Release (12) 関数など) は無効になります。
  2. EHLLAPI アプリケーションを終了する前に、接続されているホスト表示スペースを切断する必要があります。
  3. Disconnect Presentation Space 関数は、セッション・パラメーターのデフォルト値へのリセットを行いません。デフォルト値へのリセットを行うためには、EHLLAPI アプリケーションは Reset System (21) 関数を呼び出す必要があります。

Disconnect Window Service (102)


3270 5250 VT
YES YES YES

Disconnect Window Service 関数は、EHLLAPI プログラムと指定されたホスト表示スペース・ウィンドウの間のウィンドウ・サービス接続を切断します。

前提呼び出し

Connect Window Services (101)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 102 にしてください。
データ・ストリング 次の表を参照してください。
長さ 1 4
PS 位置 NA

データ・ストリングの内容


バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター


戻りコード 説明
0 Disconnect Window Service 関数は正常終了しました。
1 ユーザー・プログラムが Window Service に接続されていません。
9 システム・エラーが発生しました。

使用上の注意

Disconnect Window Service 関数を呼び出すと、アプリケーションはその表示スペース・ウィンドウを管理できなくなります。

アプリケーションを終了する前に、プレゼンテーション管理(R) サービス用に接続されているすべての表示スペースに対して Disconnect Window Service 関数を要求する必要があります。アプリケーションがウィンドウ・サービスのための接続をしたまま終了すると、サブシステムがその接続を取り消します。

Find Field Length (32)


3270 5250 VT
YES YES YES

Find Field Length 関数は、接続されている表示スペース内の該当フィールドの長さを戻します。この関数は、 フィールド形式 のホスト表示スペース内のフィールドに限り、保護フィールドや無保護フィールドを検索するのに使用できます。

この関数は、呼び出し PS 位置パラメーターを使用して識別したフィールドに入っている文字の数を戻します。このフィールドには、該当フィールドの先頭文字から次の属性バイトの前の文字までのすべての文字が含まれます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 32 にしてください。
データ・ストリング 次の表を参照してください。
長さ NA NA
PS 位置 注を参照。
注:
PS 位置: Find を開始するホスト表示スペース内のフィールドを識別します。これは、Find を開始するフィールド内のどのバイトの PS 位置でも構いません。

2 文字の呼び出しデータ・ストリングの内容は次のとおりです。

コード 説明
ブランク・スペース文字 ブランク・スペース文字 または T ブランク・スペース文字 このフィールド。
P ブランク・スペース文字 前のフィールド。保護、無保護のいずれでも可。
N ブランク・スペース文字 次のフィールド。保護または無保護。
NP 次の保護フィールド。
NU 次の無保護フィールド。
PP 前の保護フィールド。
PU 前の無保護フィールド。
注:
ブランク・スペース文字 記号は、必要なブランクを表します。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
次の長さが有効です。

長さ 説明
= 0 戻りコード = 28 の時、フィールドの長さが 0。戻りコード = 24 の時、ホスト表示スペースがフィールド形式ではない。
> 0 ホスト表示スペース内の必要なフィールドの長さ。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Find Field Length 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター・エラーが発生しました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 該当するフィールドがありません。
28 フィールドの長さが 0 バイトです。

使用上の注意

ブランク・スペース文字 ブランク・スペース文字 または T ブランク・スペース文字 が呼び出しデータ・ストリングとして使用される場合を除き、見つかったフィールドが Find を開始したフィールドと同じ場合には、戻りコード 24 が戻されます。

Find Field Position (31)


3270 5250 VT
YES YES YES

Find Field Position 関数は、ホスト接続されている表示スペース内の該当フィールドの開始位置を戻します。この関数は、フィールド形式の ホスト表示スペース内のフィールドに限り、保護フィールドや無保護フィールドを検索するのに使用できます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 31 にしてください。
データ・ストリング 次の表を参照してください。
長さ NA NA
PS 位置 注を参照。
注:
PS 位置: Find を開始するホスト表示スペース内のフィールドを識別します。これは、Find を開始したいフィールド内のどのバイトの PS 位置でも構いません。

2 文字の呼び出しデータ・ストリングの内容は次のとおりです。

コード 説明
ブランク・スペース文字 ブランク・スペース文字 または T ブランク・スペース文字 このフィールド。
P ブランク・スペース文字 前のフィールド。保護、無保護のいずれでも可。
N ブランク・スペース文字 次のフィールド。保護または無保護。
NP 次の保護フィールド。
NU 次の無保護フィールド。
PP 前の保護フィールド。
PU 前の無保護フィールド。
注:
ブランク・スペース文字 記号は、必要なブランクを表します。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
次の長さが有効です。

長さ 説明
= 0 戻りコード = 28 の時、フィールドの長さが 0。戻りコード = 24 の時、ホスト表示スペースがフィールド形式ではない。
> 0 ホスト表示スペースの起点からの、要求されたフィールドの相対的位置。この位置は、属性バイトの直後になるように定義されています。

 

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Find Field Position 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター・エラーが発生しました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 該当するフィールドがありません。
28 フィールドの長さが 0 バイトです。

使用上の注意

ブランク・スペース文字 ブランク・スペース文字 または T ブランク・スペース文字 が呼び出しデータ・ストリングとして使用される場合を除き、見つかったフィールドが Find を開始したフィールドと同じ場合には、戻りコード 24 が戻されます。

Free Communications Buffer (124)


3270 5250 VT
YES NO NO

Free Communications Buffer 関数は、アプリケーションがもう必要としないバッファーをメモリー・マネージメントに戻します。終了する前に、アプリケーションはバッファーを解放しなければなりません。

前提呼び出し

Allocate Communications Buffer (123)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 124 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 6 にしてください。 必ず 8 にしてください。
PS 位置 NA

データ・ストリングの内容


バイト位置 定義
標準 拡張  
1 ～ 2 1 ～ 4 必ず 0 にしてください。
3 ～ 6 5 ～ 8 バッファーのアドレス

戻りパラメーター


戻りコード 説明
0 Free Communications Buffer 関数は正常終了しました。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
41 要求されたバッファーは使用中です。

使用上の注意

  1. アプリケーションが使用中のバッファーを解放しようとすると、その解放要求は拒否され、戻りコード 41 が戻されます。
  2. アプリケーションを終了する前に、Allocate Communications Buffer (123) 関数を使用して割り振られたすべての通信バッファーに対して Free Communications Buffer (124) 関数を要求する必要があります。
  3. Reset System (21) 関数を使用することによっても、Allocate Communications Buffer (123) 関数で割り振られたバッファーを解放できます。

Get Key (51)


3270 5250 VT
YES YES YES

Get Key 関数を使用して、Start Keystroke Intercept (50) 関数によって指定したセッションからのキー・ストロークを EHLLAPI アプリケーション・プログラムで取り出し、そのキー・ストロークを処理、受け入れ、または拒否することができます。この関数をループに入れることにより、ストリングの代行受信に使用できます。

前提呼び出し

Start Keystroke Intercept (50)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 51 にしてください。
データ・ストリング 次の表を参照してください。
長さ 8 12
PS 位置 NA

データ・ストリングの内容


バイト位置 定義
標準 拡張  
1 1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名 (PSID)
  • ホスト接続表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
2 ～ 8 5 ～ 11 要求されたデータのシンボリック表示用のスペース確保のためのブランク
12 予約済み

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
次の表を参照してください。

バイト位置 定義
標準 拡張  
1 1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名 (PSID)
  • ホスト接続表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
2 5 次のいずれかのオプションのコード文字:
  • ASCII が戻されたことを示す A
  • キー・ストローク略号を示す M
  • 特殊略号を示す S
3 ～ 8 6 ～ 11 この事前割り振りされた 6 バイトのバッファー・スペースは、キー・ストロークのエンキューおよびデキューのために内部的に使用されます。以下の組み合わせが可能:
  • バイト 3 に ASCII 文字、バイト 4 に X'00'
  • バイト 3 および 4 に 2 バイト文字
  • バイト 3 にエスケープ文字 (@、または機能 9 の ESC=c オプションを使用して指定したその他の文字) およびバイト 4 に 1 バイトの関数の省略文字。 (ASCII 略号を参照してください。)
  • バイト 5 ～ 8 は、戻された ASCII 略号が 2 バイトより長い場合、バイト 3 および 4 と同様になります (例えば、Attn の ASCII 略号が @A@Q の場合、バイト 5 に @、バイト 6 に Q が入ります)。使用されない場合、バイト 5 ～ 8 は 0 (X'00') に設定されます。

説明のため、戻されるデータ・ストリングの例を以下に示します。

注:
@ 記号はデフォルトのエスケープ文字です。エスケープ文字の値は、Set Session Parameters (9) 関数の ESC=c オプションを使用して ASCII で表される任意のキー・ストロークに設定できます。このオプションを使用して、エスケープ文字を別の文字に変更している場合は、以下の例の中の @ 記号をその変更している文字に置き換えて考えてください。

16 ビット・インターフェースの場合

EAt
E は表示スペースの短縮名です。キー・ストロークは ASCII として戻され (A)、戻されるキーは小文字の t です (バイト 4 ～ 8 = X'00')。

EM@2
E は表示スペースの短縮名です。キー・ストロークは略号として戻され、戻されるキーは PF2 です (バイト 5 ～ 8 = X'00')。

32 ビット・インターフェースの場合

E ブランク・スペース文字 ブランク・スペース文字 ブランク・スペース文字At
E は表示スペースの短縮名です。キー・ストロークは ASCII として戻され (A)、戻されるキーは小文字の t です (バイト 7～11 = X'00')。

E ブランク・スペース文字 ブランク・スペース文字 ブランク・スペース文字 M@2
E は表示スペースの短縮名です。キー・ストロークは略号として戻され、戻されるキーは PF2 です (バイト 8 ～ 11 = X'00')。

戻りコード:
以下のコードが有効です。

戻りコード 説明
0 Get Key 関数は正常終了しました。
1 無効な表示スペースが指定されました。
5 Start Keystroke Intercept (50) 関数で AID 専用オプションが指定されました。EHLLAPI が表示スペースに無効なキーを書き込もうとする時には、このセッション・タイプでは非 AID キーは禁止されます。
8 この表示スペースに対して、先に Start Keystroke Intercept (50) 関数が呼び出されていません。
9 システム・エラーが発生しました。
20 定義されていないキーの組み合わせがタイプされました。
25 要求されたキー・ストロークは入力キューで使用できません。
31 キー・ストロークのキューがオーバーフローし、キー・ストロークが失われました。

使用上の注意

  1. Get Key 関数で戻りコード 31 が発生する場合、以下のどちらかを行ってください。

    代行受信されたキー・ストロークは、バッファー中の 3 バイトを使用します。次の代行受信されたキー・ストロークは、隣接する 3 バイトに置かれます。 Get Key 関数がキー・ストロークを取り出す (先入れ先出し、FIFO) と、そのキー・ストロークが使用していた 3 バイトは他のキー・ストロークで使用できるようになります。バッファーのサイズを増やすか、バッファーからキー・ストロークを取り出す頻度を増やすことによって、バッファーのオーバーフローを避けることができます。

    PC/3270 において、戻りコード 31 を除去する他の方法は、再開モードで PC/3270 エミュレーターを操作することです。

  2. Send Key (3) 関数を使用して、元のキー・ストロークと EHLLAPI アプリケーションに必要な他のキー・ストロークの両方を、ホスト接続表示スペースに渡すことができます。
  3. キー・ストロークは非同期に受信され、Start Keystroke Intercept (50) 関数を使用して EHLLAPI アプリケーション・プログラムで指定したキー・ストロークのキューに入れられます。
  4. Get Key 関数は read コマンドと同様に機能します。キー・ストロークが使用可能な場合、キー・ストロークはユーザーのアプリケーションで用意したデータ域に読み込まれます。
  5. セッションに対するフィールド・サポートの場合、アプリケーションは Enter キーなどの AID キーだけが必要かもしれません。この場合には、Start Keystroke Intercept (50) 関数のオプション・コードを D (AID キー専用を表す) に設定します。
  6. この関数を使用するには、戻りデータ・ストリング・パラメーターを受け入れるメモリーを事前に割り振ります。このメモリーの事前割り振りに必要なステートメントは、アプリケーションに使用される言語によって異なります。詳細については、メモリー割り振りを参照してください。

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

セッション・オプション ESC はユニコード・セッションではサポートされていません。このオプションを使用してユニコード文字を ESC 文字として設定することはできません。デフォルトの ESC 文字 @ をユニコード・セッションで使用してください。詳細については、Set Session Parameters (9)を参照してください。

前提呼び出し

Start Keystroke Intercept (50)

呼び出しパラメーター

  標準インターフェース 拡張インターフェース
関数番号 必ず 51 にしてください。
データ・ストリング 次の表を参照してください。
長さ 8 12
PS 位置 NA

データ・ストリングの内容

バイト位置 定義
標準 拡張  
1 1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名 (PSID)
  • ホスト接続表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
2 ～ 8 5 ～ 11 要求されたデータのシンボリック表示用のスペース確保のためのブランク
12 予約済み

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
32 ビット・インターフェースについては、次の表を参照してください。

バイト位置 定義
1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名 (PSID)
  • ホスト接続表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
5 U はユニコード・セッションのオプション・コード文字です。
6 ～ 11 これらのバイトの定義は DBCS セッションの場合と似ています。異なる点は、オプション・コード文字が U の場合はユニコード文字の値がバイト 6 と 7 に保管される点です。DBCS セッションでは、オプション・コード文字が A の場合に ASCII 文字の値はバイト 3 に保管され、バイト 4 には 0X'00' が入っています。

戻りコード:
以下のコードが有効です。

戻りコード 説明
0 Get Key 関数は正常終了しました。
1 無効な表示スペースが指定されました。
5 Start Keystroke Intercept (50) 関数で AID 専用オプションが指定されました。EHLLAPI が表示スペースに無効なキーを書き込もうとする時には、このセッション・タイプでは非 AID キーは禁止されます。
8 この表示スペースに対して、先に Start Keystroke Intercept (50) 関数が呼び出されていません。
9 システム・エラーが発生しました。
20 定義されていないキーの組み合わせがタイプされました。
25 要求されたキー・ストロークは入力キューで使用できません。
31 キー・ストロークのキューがオーバーフローし、キー・ストロークが失われました。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

セッション・オプション ESC はユニコード・セッションではサポートされていません。このオプションを使用してユニコード文字を ESC 文字として設定することはできません。デフォルトの ESC 文字 @ をユニコード・セッションで使用してください。詳細については、Set Session Parameters (9)を参照してください。

前提呼び出し

Start Keystroke Intercept (50)

呼び出しパラメーター

  標準インターフェース 拡張インターフェース
関数番号 必ず 51 にしてください。
データ・ストリング 次の表を参照してください。
長さ 8 12
PS 位置 NA

データ・ストリングの内容

バイト位置 定義
標準 拡張  
1 1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名 (PSID)
  • ホスト接続表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
2 ～ 8 5 ～ 11 要求されたデータのシンボリック表示用のスペース確保のためのブランク
12 予約済み

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
32 ビット・インターフェースについては、次の表を参照してください。

バイト位置 定義
1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名 (PSID)
  • ホスト接続表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
5 U はユニコード・セッションのオプション・コード文字です。
6 ～ 11 これらのバイトの定義は SBCS セッションの場合と似ています。異なる点は、オプション・コード文字が U の場合はユニコード文字の値がバイト 6 と 7 に保管される点です。 DBCS セッションでは、オプション・コード文字が A の場合に ASCII 文字の値はバイト 3 に保管され、バイト 4 には 0X'00' が入っています。

戻りコード:
以下のコードが有効です。

戻りコード 説明
0 Get Key 関数は正常終了しました。
1 無効な表示スペースが指定されました。
5 Start Keystroke Intercept (50) 関数で AID 専用オプションが指定されました。EHLLAPI が表示スペースに無効なキーを書き込もうとする時には、このセッション・タイプでは非 AID キーは禁止されます。
8 この表示スペースに対して、先に Start Keystroke Intercept (50) 関数が呼び出されていません。
9 システム・エラーが発生しました。
20 定義されていないキーの組み合わせがタイプされました。
25 要求されたキー・ストロークは入力キューで使用できません。
31 キー・ストロークのキューがオーバーフローし、キー・ストロークが失われました。

Get Request Completion (125)


3270 5250 VT
YES NO NO

Get Request Completion 関数によって、アプリケーションは EHLLAPI に対して前回発行した非同期の関数要求の状況を判断して、データ・ストリングを再び使用する前に関数パラメーターのリストを取得できます。この関数は、Read Structured Fields (126) や Write Structured Fields (127) などの関数を前回呼び出した際に、ユーザーが非同期の (A) 完了を指定した場合に限り有効です。

Get Request Completion 関数が必要な非同期要求はそれぞれ、非同期要求から固有の ID を戻します。アプリケーションはこの ID を保管する必要があります。この ID は、必要な要求を識別するために Get Request Completion 関数が使用する ID です。ユーザーは、この関数を使用する際に、以下の 3 つの要求オプションを指定できます。

  1. 関数の要求 ID およびブランク以外のセッション短縮名を指定することにより、アプリケーションは特定の非同期関数要求を照会または待機できます。
  2. X'0000' という要求 ID とブランク以外のセッションの短縮名を指定することにより、アプリケーションは特定のセッションの最初に完了する非同期関数要求を照会または待機できます。

前提呼び出し

Connect Structured Fields (120) および Allocate Communications Buffer (123)

および

Read Structured Fields (126) または Write Structured Fields (127)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 125 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 14 にしてください。 必ず 24 にしてください。
PS 位置 NA

データ・ストリングの内容


バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 5 N または W。N=NOWAIT (非待機) が要求されました。W=WAIT (待機) が要求されました。

6 ～ 8 予約済み
3 ～ 4 9 ～ 10 関数要求 ID
5 ～ 6 11 ～ 12 予約済み
7 ～ 10 13 ～ 16 予約済み
11 ～ 12 17 ～ 20 予約済み
13 ～ 14 21 ～ 24 予約済み

Get Request Completion 関数の動作は、パラメーター・ストリングの 2 番目の文字により異なります。その文字は以下のいずれかです。

N
非待機オプション: 特定の要求 ID が指定され、その関数が完了している場合、戻りコード 0 および戻りパラメーターに定義された完了済みデータ・ストリングと共に、アプリケーションに制御が戻されます。要求 ID に 0 が指定され、該当する非同期関数が完了している場合、戻りコード 0 および戻りパラメーターに定義された完了済みデータ・ストリングと共に、アプリケーションに制御が戻されます。

W
待機オプション: 特定の要求 ID が指定され、関数が完了していない場合、呼び出しは関数が完了するのを待ってからアプリケーションに戻ります。要求 ID に 0 が指定され、該当する非同期関数が完了していない場合、呼び出しは関数が完了するのを待ってから呼び出し側のアプリケーションに戻ります。アプリケーションに戻った時点で、戻りコードの値は 0 になり、データ・ストリングは戻りパラメーターに定義されたとおりに完成されます。

戻りパラメーター


バイト位置 定義
標準 拡張  
5 ～ 6 11 ～ 12 完了した非同期関数の関数番号 (126 または 127)(戻り)
7 ～ 10 13 ～ 16 完了した非同期関数呼び出しのデータ・ストリングのアドレス (アプリケーションは要求が完了するまでデータ・ストリングを再度使用することができません)。 (戻り)
11 ～ 12 17 ～ 20 完了した非同期関数呼び出しのデータ・ストリングの長さ。 (戻り)
13 ～ 14 21 ～ 24 完了した非同期関数呼び出しの戻りコード。 (戻り)

戻りコード 説明
0 Get Request Completion 関数は正常終了しました。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
38 要求された関数は完了しませんでした。
42 該当する要求がありません。

戻りコード 38 と 42 には、次のような相違点があります。

  1. 戻りコード 38
    1. 特定の要求 ID とセッションが要求された場合、セッションと ID の両方とも検出されたにもかかわらず、要求が保留されている (完了状態でない)。
    2. 要求 ID ゼロと特定のセッションが要求された場合、指定されたセッションに保留されている要求があるが、それらの要求は満たされて (完了して) いない。
    3. 要求 ID ゼロとブランク・セッションが要求された場合、保留されている要求が見つかったが、どれも要求が満たされて (完了して) いない。
  2. 戻りコード 42
    1. 特定の要求 ID とセッションが要求された場合、特定の要求 ID が保留状態でも完了状態でも検出されない。
    2. 要求 ID ゼロと特定のセッションが要求された場合、その特定のセッションに保留要求または完了済み要求が含まれていない。
    3. 要求 ID ゼロとブランク・セッションが要求された場合、保留要求も完了済み要求も検出されなかった。

使用上の注意

  1. この関数は、ユーザーが Read Structured Fields または Write Structured Fields などの関数を前回呼び出した際に、非同期完了 (Asynchronous の A) を指定した場合に限り有効です。
  2. 戻りコードが 0 の場合、アプリケーションは、要求された非同期関数の完了に関する情報が入っている、戻されたデータ・ストリングを検査する必要があります。

Lock Presentation Space API (60)


3270 5250 VT
YES NO NO

Lock Presentation Space API 関数によって、アプリケーションは、他の Windows 32 ビット・アプリケーションに対して、表示スペース・ウィンドウの排他制御を獲得したり解放したりすることができます。ロックされている間、他のアプリケーションは表示スペース・ウィンドウに接続することはできません。

ロックを指定したこの関数が正常に処理されると、他の EHLLAPI アプリケーションから要求された EHLLAPI 表示スペース・ウィンドウ関数は、この関数を要求したアプリケーションが表示スペースをアンロックするまで、待機させられます。ロックを行ったアプリケーションからの要求は、通常どおり処理されます。

前提呼び出し

Connect to Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 60 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 3 にしてください。 必ず 8 にしてください。
PS 位置 NA

データ・ストリングの内容


バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 4 予約済み。
2 5 次のいずれかを示します。
  • L - API をロックする場合。
  • U - API をアンロックする場合
3 6 次のいずれかを示します。
  • R - 表示スペースがすでにアプリケーションによってロックされているときに戻る場合。
  • Q - 表示スペースがすでにアプリケーションによってロックされているときに、ロック要求をキューに入れる場合。
7 ～ 8 予約済み。

戻りパラメーター


戻りコード 説明
0 Lock Presentation Space API 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
43 API がすでに他の EHLLAPI アプリケーションによってロックされていたか (ロック要求の場合)、または API がロックされていませんでした (アンロック要求の場合)。

使用上の注意

以下の EHLLAPI 関数は、ロックされている間は待機させられます。

これらの待機させられた要求は、ロックが解除されるまでサービスされません。ロックが解除されると、待機させられた要求は、先入れ先出し法 (FIFO) の順序で処理されます。上記以外の EHLLAPI 関数は、ロックされていない場合と同じように実行されます。ロックを要求したアプリケーションは、以下のいずれかの方法で、表示スペース・ウィンドウをアンロックします。

アプリケーションを終了する前に、Lock Presentation Space API 関数を使用してロックしていたすべての表示スペース・ウィンドウをアンロックする必要があります。アプリケーションが未処理のロックをそのままにして終了するか、Reset System (21) 関数または Disconnect Presentation Space (2) 関数が発行されると、ロックは解放されます。

アプリケーションでは、短時間に限り、しかも表示スペースの排他的使用が必要なときにのみ、表示スペースをロックすることをお勧めします。

Lock Window Services API (61)


3270 5250 VT
YES NO NO

Lock Window Services API 関数によって、アプリケーションは、他の Windows 32 ビット・アプリケーションに対して、表示スペース・ウィンドウの排他制御を獲得したり解放したりすることができます。ロックされている間、他のアプリケーションは表示スペース・ウィンドウに接続することはできません。

ロックを指定したこの関数が正常に処理されると、他の EHLLAPI アプリケーションから要求された EHLLAPI 表示スペース・ウィンドウ関数は、この関数を要求したアプリケーションが表示スペースをアンロックするまで、待機させられます。ロックを行ったアプリケーションからの要求は、通常どおり処理されます。

前提呼び出し

Connect Window Services (101)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 61 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 3 にしてください。 必ず 8 にしてください。
PS 位置 NA

データ・ストリングの内容


バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 4 予約済み。
2 5 次のいずれかを示します。
  • L - API をロックする場合。
  • U - API をアンロックする場合
3 6 次のいずれかを示します。
  • R - 表示スペースがすでにアプリケーションによってロックされているときに戻る場合。
  • Q - 表示スペースがすでにアプリケーションによってロックされているときに、ロック要求をキューに入れる場合。
5 ～ 6 11 ～ 12 完了した非同期関数の関数番号 (126 または 127)(戻り)
7 ～ 8 予約済み。

戻りパラメーター


戻りコード 説明
0 Lock Window Services API 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
38 要求された関数は完了しませんでした。
43 API がすでに他の EHLLAPI アプリケーションによってロックされていたか (ロック要求の場合)、または API がロックされていませんでした (アンロック要求の場合)。

使用上の注意

以下の EHLLAPI 関数は、ロックされている間は待機させられます。

これらの待機させられた要求は、ロックが解除されるまでサービスされません。ロックが解除されると、待機させられた要求は、先入れ先出し法 (FIFO) の順序で処理されます。

ロックを要求したアプリケーションは、以下のいずれかの方法で、表示スペース・ウィンドウをアンロックします。

アプリケーションを終了する前に、Lock Window Services API 関数を使用してロックしていたすべての表示スペース・ウィンドウをアンロックする必要があります。アプリケーションがロックを未処理のまま終了すると、サブシステムはそのロックを解放します。

アプリケーションでは、短時間に限り、しかも表示スペースの排他的使用が必要なときにのみ、表示スペースをロックすることをお勧めします。

Pause (18)


3270 5250 VT
YES YES YES

Pause 関数は、指定した時間だけ待機します。この機能をタイミング・ループ の代わりに使用して、イベントの発生を待機することができます。 Pause 関数は、先に Start Host Notification (23) 関数が呼び出され、IPAUSE オプションが選択されている場合、ホストのイベントにより終了できます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 18 にしてください。
データ・ストリング NA
長さ 2 分の 1 秒単位で待機時間を指定します
PS 位置 NA

戻りパラメーター


戻りコード 定義
0 待機時間が終了しました。
9 内部システム・エラーが発生しました。時間の結果は予測できません。
26 ホスト・セッションの表示スペースまたは OIA がすでに更新されています。詳細情報を得るには、Query Host Update (24) 関数を使用してください。

使用上の注意

  1. Set Session Parameters (9) 関数を使用して、FPAUSE オプションか IPAUSE オプションを選択すると、この関数を呼び出すときの停止時間の長さに影響を与えます。詳しくは、6 を参照してください。
  2. 呼び出しデータ・ストリング長パラメーターに入力される値は、 Pause 関数が待機する時間の最大数 (2 分の 1 秒単位) です。 20 秒の休止の場合、呼び出しデータ・ストリング長パラメーターに 16 進数値の 0028 (10 進数で 40) を渡す必要があります。
  3. IPAUSE オプションを使用し、Pause 関数の値がゼロの場合、Pause 関数は最大 2400 (2 分の 1 秒単位) 待機します (これより前に割り込みが発生しない場合)。 FPAUSE オプションを使用し、Pause 関数の値がゼロの場合は、この関数は即座に戻ります。
  4. IPAUSE オプションを使用する時は、ホストのイベントにより一時停止の条件が満たされたら、Query Host Update (24) 関数を呼び出して次の Pause 関数の前にキューを消去してください。 Pause 関数は、Query Host Update (24) 関数が完了するまで、継続して保留状態のイベントの条件を満たします。

  5. Pause 関数の実際の最大値は 2400 です。 Pause 関数は次のようなタスクには使用しないでください。
  6. IPAUSE 設定および割り込み可能休止は、指定されたホスト表示スペース (PS) またはオペレーター情報域 (OIA) が更新されたかどうかを EHLLAPI アプリケーションが判別できるようにします。以下の 3 つの関数を使用します。

    Start 関数が呼び出されるときに IPAUSE を使用して、ホスト表示スペースまたは OIA (あるいはこの両方) が更新を受信するまで、アプリケーションを待機させることができます。受信が完了し、アプリケーションが変更点を判別するために Query 関数を発行できるようになった時点で、Pause は終了します。続いて、アプリケーションは Search Presentation Space (6) を発行し、予期した更新が行われたかどうか調べます。

Post Intercept Status (52)


3270 5250 VT
YES YES YES

Post Intercept Status 関数は、Get Key (51) 関数によって得られたキー・ストロークが受け入れられたか拒否されたかをパーソナル・コミュニケーションズ・エミュレーターに通知します。アプリケーションがキー・ストロークを拒否した場合には、Post Intercept Status 関数はビープ音を出します。

前提呼び出し

Start Keystroke Intercept (50)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 52 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 2 にしてください。 必ず 8 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名
  • ホスト接続表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
2 5 次のいずれかを示します。
  • A -- キー・ストロークの受け入れ
  • R -- キー・ストロークの拒否
6 ～ 8 予約済み。

戻りパラメーター


戻りコード 説明
0 Post Intercept Status 関数は正常終了しました。
1 無効な表示スペースが指定されました。
2 無効なセッション・オプションが指定されました。
8 この表示スペース ID に対して、先に Start Keystroke Intercept (50) 関数が呼び出されていません。
9 システム・エラーが発生しました。

Query Additional Field Attribute (45)


3270 5250 VT
NO YES NO

Query Additional Field Attribute 関数はホスト表示スペースの入力位置がある 5250 フィールドについての追加情報を戻します。この情報は定義済み構造の形式でデータ・ストリング・パラメーターに戻されます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 45 にしてください。
データ・ストリング 8 バイト長の文字ストリング。
長さ 8 が暗黙指定されます。
PS 位置 コピー先フィールドを識別します。これはコピー先フィールド内のどのバイトの PS 位置でも構いません。

呼び出しデータ・ストリングには次のものがあります。


バイト位置 定義
1-8 予約済み

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
関数は以下のデータ・ストリングを戻します。


バイト位置 定義
1-6 予約済み
7 ～ 8 以下を戻す、2 つの 8 ビット符号なし文字。
  • フィールドが RTL であれば R、またフィールドが LTR であれば L。
  • フィールドが大文字であれば U、フィールドが標準のケース・フィールドであれば L。

戻りコード:
以下の戻りコードが定義されています。

戻りコード 説明
0 Query Additional Field Attribute 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
7 ホスト表示スペースの位置が正しくありません。
9 この位置ではフィールドが検出できませんでした。
24 フィールドが定様式化されていません。

Query Close Intercept (42)


3270 5250 VT
YES YES YES

Query Close Intercept 関数を使用して、アプリケーションはクローズ・オプションが選択されたかどうかを識別できます。

前提呼び出し

Start Close Intercept (41)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 42 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 1 にしてください。 必ず 4 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 ホスト表示スペースの 1 文字の短縮セッション ID、またはホスト接続されているセッションへの照会要求を示すブランクあるいは NULL。
2 ～ 4 予約済み

戻りパラメーター


戻りコード 説明
0 クローズ割り込みは生じませんでした。
1 プレゼンテーション・ソースが正しくありません。
2 パラメーター指定でエラーが発生しました。
8 このホスト表示スペースに対して、先に Start Close Intercept (41) 関数が呼び出されていません。
9 システム・エラーが発生しました。
12 セッションが停止しました。
26 最後の Query Close Intercept 呼び出し後にクローズ・インターセプトが発生しました。

Query Communications Buffer Size (122)


3270 5250 VT
YES NO NO

Query Communications Buffer Size 関数を使用して、アプリケーションは、エミュレーション・プログラムがサポートするバッファーの最大サイズおよび最適サイズを判別することができます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 122 にしてください。
データ・ストリング 次の表を参照してください。
長さ 必ず 9 にしてください。 必ず 20 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 ～ 3 5 ～ 8 サポートされるインバウンド・バッファーの最適サイズを示す 16 ビット/32 ビットのフィールド (戻される値)
4 ～ 5 9 ～ 12 サポートされるインバウンド・バッファーの最大サイズを示す 16 ビット/32 ビットのフィールド (戻される値)
6 ～ 7 13 ～ 16 サポートされるアウトバウンド・バッファーの最適サイズを示す 16 ビット/32 ビットのフィールド (戻される値)
8 ～ 9 17 ～ 20 サポートされるアウトバウンド・バッファーの最大サイズを示す 16 ビット/32 ビットのフィールド (戻される値)

戻りパラメーター


戻りコード 説明
0 Query Communications Buffer Size 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
10 エミュレーション・プログラムはこの関数をサポートしていません。

使用上の注意

  1. この関数を使用するようにユーザーに要求する方法はありません。これは必須の関数ではなく、アプリケーションはあらゆるシステムで実行するように調整できます。
  2. 戻されるバッファー・サイズは、実際にメディアを通じて送信されるレコードのサイズを表しています。 DDM 接続の場合、読み取り構造化フィールドと 書き込み構造化フィールドのデータ・バッファーに与えられる 8 バイトのヘッダーは取り除かれ、構造化フィールドの AID 値を含む 1 バイトが接頭部になります。アプリケーションは、データ・バッファー内の実際のデータ・サイズ (8 バイトのヘッダーを含めない) と、Query Communications Buffer Size 機能が戻すバッファー・サイズから 1 バイト引いたものを比較する必要があります。 Destination/Origin 接続の場合も、読み取り構造化フィールドと書き込み構造化フィールドのデータ・バッファーに与えられる 8 バイトが取り除かれ、9 バイトがデータの接頭部になります。アプリケーションは、データ・バッファー内の実際のデータ・サイズ (8 バイトのヘッダーを含めない) と、Query Communications Buffer Size 機能が戻すバッファー・サイズから 9 バイト引いたものを比較する必要があります。
  3. 最大バッファー・サイズは、ワークステーションのハードウェアがサポートするバイトの最大数、およびエミュレーターがサポートするバイトの最大数を表します。この最大バッファー・サイズは、ホスト側でも少なくともこれらの最大サイズを受け入れるように構成されていれば、使用することができます。
  4. 戻される最適バッファー・サイズはワークステーションのハードウェアとエミュレーターの両方がサポートする最適バイト数を表しています。ネットワーク構成によっては、下限値をこの最適バッファー・サイズ未満に設定しているものもあります。このような場合、構造化フィールドのサポートには、エミュレーター構成プロファイルのデータ転送バッファー・サイズの一時変更値が使用されます。エミュレーターの構成プロファイル内のバッファー・サイズの一時変更値は、Query Communications Buffer Size に反映されます。

Query Communication Event (81)


3270 5250 VT
YES YES YES

Query Communication Event 関数を使用して、 EHLLAPI プログラムは、通信イベントが発生したかどうかを判別することができます。

前提呼び出し

Start Communication Notification (80)

呼び出しパラメーター


  拡張インターフェース
関数番号 必ず 81 にしてください。
データ・ストリング 1 文字のホスト表示スペースの短縮名、またはホスト接続されている表示スペースへの更新要求を示すブランクまたは NULL。
長さ 4 が暗黙指定されます。
PS 位置 NA

呼び出しデータ構造には、以下の要素が含まれます。

バイト位置 定義
1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター


戻りコード 定義
0 関数は正常終了しました。
1 誤った PSID が指定されました。
8 この PSID に対して、先に Start Communication Notification (80) 関数が呼び出されていません。
9 システム・エラーが発生しました。
21 指示された PSID が接続されました。
22 指示された PSID が切断されました。

Query Cursor Location (7)


3270 5250 VT
YES YES YES

Query Cursor Location 関数は、カーソル位置を戻すことにより、ホスト接続表示スペース内のカーソルの位置を示します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 7 にしてください。
データ・ストリング NA
長さ NA
PS 位置 NA

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
カーソルのあるホスト表示スペースの位置

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Query Cursor Location 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
9 システム・エラーが発生しました。

Query Field Attribute (14)


3270 5250 VT
YES YES YES

Query Field Attribute 関数は、ホスト表示スペースの入力位置があるフィールドの属性バイトを戻します。この情報は、戻りデータ・ストリング長パラメーターに戻されます。

PC/3270 については、次のことに注意してください。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 14 にしてください。
データ・ストリング NA
長さ NA
PS 位置 コピー先フィールドを識別します。これはコピー先フィールド内のどのバイトの PS 位置でも構いません。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
画面が定様式の場合には属性値、画面が不定様式の場合には 0 となります。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Query Field Attribute 機能は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 属性バイトがないか、またはホスト表示スペースが定様式化されていません。

使用上の注意

戻されるフィールド属性の定義を以下の表に示します。ビット位置は、バイトの左端をビット 0 とする IBM 形式で表されます。


ビット位置 意味
0 ～ 1 共に 1。フィールド属性バイト。
2 保護/無保護

0 = 無保護データ・フィールド

1 = 保護フィールド

3 A/N

0 = 英数字データ

1 = 数値データのみ

4 ～ 5 I/SPD

00 = 通常輝度、pen 検出不能

01 = 通常輝度、pen 検出可能

10 = 高輝度、pen 検出可能

11 = 非表示、pen 検出不能

6 予約済み
7 MDT

0 = フィールドは変更されていません。

1 = フィールドは変更されました。


ビット位置 意味
0 フィールド属性フラグ

0 = フィールド属性フラグなし

1 = フィールド属性フラグあり

1 可視性

0 = 非表示

1 = 表示

2 保護/無保護

0 = 無保護データ・フィールド

1 = 保護フィールド

3 輝度

0 = 通常輝度

1 = 高輝度

4 ～ 6 フィールド・タイプ

000 = 英数字データ: 全文字使用可。

001 = 英字のみ: 大文字と小文字、コンマ、ピリオド、ハイフン、ブランク、Dup キーが使用可。

010 = 数字シフト: 数字に対する自動シフト

011 = 数字のみ: 0 ～ 9 の数字、コンマ、ピリオド、プラス、マイナス、ブランク、Dup キーが使用可。

101 = 数字のみ: 0 ～ 9 の数字、Dup キーが使用可。

110 = 磁気ストライプ読み取り装置データのみ

111 = 符号付き数字: 0 ～ 9 の数字、プラス、マイナス、Dup キーが使用可。

7 MDT

0 = フィールドは変更されていません。

1 = フィールドは変更されました。

Query Host Update (24)


3270 5250 VT
YES YES YES

Query Host Update 関数により、プログラム式操作は、次のいずれかにより、ホストがホスト表示スペースまたは OIA を変更したかどうか判別できます。

前提呼び出し

Start Host Notification (23)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 24 にしてください。
データ・ストリング 1 文字のホスト表示スペースの短縮名、またはホスト接続されている表示スペースへの更新要求を表すブランクあるいは NULL。
長さ 1 が暗黙指定されます。 4 が暗黙指定されます。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター


戻りコード 定義
0 最後の呼び出し以降、更新されていません。
1 ホストの無効な表示スペースが指定されました。
8 このホスト表示スペース ID に対して、先に Start Host Notification (23) 関数が呼び出されていません。
9 システム・エラーが発生しました。
21 OIA が更新されました。
22 表示スペースが更新されました。
23 OIA とホスト表示スペースが更新されました。
44 印刷は、プリンター・セッションで完了しています。

使用上の注意

該当する表示スペースをデータ・ストリングに指定しておくことが必要です。ただし、更新の検査のためにホスト表示スペースに接続する必要はありません。

Query Session Status (22)


3270 5250 VT
YES YES YES

Query Session Status 関数は、セッション特有の情報を得るために使用します。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  16 ビット 32 ビット
関数番号 必ず 22 にしてください。
データ・ストリング 該当表示スペースの短縮セッション ID (1 バイト) に、戻りデータ用の 17 バイトを加えた、18/20 バイトのストリング。バイト位置 1 には、次のものを入れることができます。

  1. ホスト接続の表示スペースに対する要求を示すブランクまたは NULL 文字。
  2. キーボード・オーナーの表示スペースに対する要求を示す * (アスタリスク)。
長さ 必ず 18 にしてください。 必ず 20 にしてください。
PS 位置 NA

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 ～ 9 5 ～ 12 セッションの正式名 (プロファイル名と同じ。またはプロファイルが設定されていない場合は、短縮名と同じ)
10 13

セッション
タイプ

D
3270 表示装置

E
3270 印刷装置

F
5250 表示装置

G
5250 印刷装置

H
ASCII VT

11 14 セッションの特性。以下のセッション特性ビットを含む 2 進数で表されています。

ビット 0
EAB  0: セッションには基本属性があります。  1: セッションには拡張属性があります。

ビット 1
PSS  0: セッションはプログラム・シンボルをサポートしていません。  1: セッションはプログラム・シンボルをサポートしています。

ビット 2 ～ 7
予約済み
12 ～ 13 15 ～ 16 ホスト表示スペースの行数。 2 進数で表されます。
14 ～ 15 17 ～ 18 ホスト表示スペースの桁数。 2 進数で表されます。
16 ～ 17 19 ～ 20 ホスト・コード・ページ数。 2 進数で表されます。
18 予約済み

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Query Session Status 関数は正常終了しました。
1 ホストの無効な表示スペースが指定されました。
2 ストリング長が正しくありません。
9 システム・エラーが発生しました。

使用上の注意

  1. この関数を使用するには、戻りデータ・ストリング・パラメーターを受け入れるメモリーを事前に割り振ります。このメモリーの事前割り振りに必要なステートメントは、アプリケーションに使用される言語によって異なります。詳細については、メモリー割り振りを参照してください。

Query Sessions (10)


3270 5250 VT
YES YES YES

Query Sessions 関数により、各ホスト・セッションを記述している 16 バイト (標準インターフェースの場合は 12 バイト) のデータ・ストリングが戻されます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


関数 説明

標準インターフェース 拡張インターフェース
関数番号 必ず 10 にしてください。
データ・ストリング 16n (16 ビットの場合は 12n) バイト長以上の事前割り振りストリング (n =セッション数)。
長さ 12n バイト 16n バイト
PS 位置 NA
注:
データ・ストリング長がセッション数に合わない場合、戻りコードは 2 になります。

戻りパラメーター

この関数は、データ・ストリング、データ・ストリング長、戻りコードを戻します。

データ・ストリング:
戻されるデータ・ストリングの長さは、16n バイト (標準インターフェースの場合は 12n バイト) です。ここで、n はホスト・セッションの数です。記述子は、データ・ストリングと各セッション・タイプ、およびホスト・セッションの表示スペースのサイズと連結されています。

16 バイト (標準インターフェースの場合は 12 バイト) の各セッションの記述子の形式は次のとおりです。


バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 ～ 9 5 ～ 12 セッションの正式名 (プロファイル名と同じ。またはプロファイルが設定されていない場合は、短縮名と同じ)
10 13 接続タイプ H=host
14 予約済み
11 ～ 12 15 ～ 16 ホスト表示スペースのサイズ (表示形式ではなく、2 進数)。セッション・タイプが印刷セッションの場合、この値は 0 です。

データ・ストリング長:
開始されるホスト・セッションの数。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Query Sessions 関数は正常終了しました。
2 ストリング長が正しくありません。
9 システム・エラーが発生しました。

使用上の注意

  1. アプリケーション・プログラムが RC=2 または RC=0 を受信した場合、活動セッションの数はデータ・ストリング長のフィールドに戻されます。この数を使用して、アプリケーション・プログラムは必要な最小ストリング長を判別することができます。
  2. Query Sessions 関数は、CFGSIZE/NOCFGZISE セッション・オプション (詳細は 16 を参照) および EXTEND_PS/NOEXTEND_PS オプション (詳細は 22 を参照) の影響を受けます。

注:

  1. 5250 セッションに対して Set Session Parameters(9) に NOCFGSIZE が設定された場合、 Query Sessions(10) から戻されるバイト位置 11 および 12 の表示スペースのサイズの値は、EXTEND_PS と NOEXTEND_PS のどちらを選択するかによって異なります。

  2. EXTEND_PS が Set Session Parameters(9) で設定されたときは、Query Sessions(10) から戻される表示スペースのサイズに、メッセージ行がある場合にはそのサイズが含まれます。

  3. NOEXTEND_PS が設定された場合には、メッセージ行の有無にかかわらず、メッセージ行のサイズは含まれません。 25 行 80 桁の表示スペースの場合、このサイズは 1920 または 2000 になります。

Query System (20)


3270 5250 VT
YES YES YES

EHLLAPI プログラムでは、Query System 関数を使用して、パーソナル・コミュニケーションズのサポート・レベルおよびシステム関連のその他の値を判別することができます。この関数は該当するシステム・データを含むストリングを戻します。この情報のほとんどは、ユーザーが戻りコード 9 (システム・エラーが発生しました) を受け取った後、IBM サポート・センターに連絡したときにサービス・コーディネーターが使用するためのものです。

この戻りストリングのバイトは戻りパラメーターで定義されています。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 20 にしてください。
データ・ストリング 事前に割り振られた 35 バイトのストリング 36 バイト
長さ 必ず 35 にしてください。 必ず 36 にしてください。
PS 位置 NA

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
35 バイト (16 ビットの場合) または 36 バイト (32 ビットの場合) のデータ・ストリングが戻されます。バイトは以下のように定義されます。

バイト位置 定義
標準 拡張  
1 1 EHLLAPI バージョン番号
2 ～ 3 2 ～ 3 EHLLAPI レベル番号
4 ～ 9 4 ～ 9 予約済み
10 ～ 12 10 ～ 12 予約済み
13 13 ハードウェア・ベース、 U=判別不能
14 14 プログラム・タイプ、P=IBM パーソナル・コミュニケーションズ
15 ～ 16 15 ～ 16 予約済み
17 ～ 18 17 ～ 18 2 バイトの ASCII 値によるパーソナル・コミュニケーションズのバージョン/レベル
19 19 予約済み
20 ～ 23 20 ～ 23 予約済み
24 ～ 27 24 ～ 27 予約済み
28 ～ 29 28 ～ 29 予約済み
  30 予約済み
30 ～ 31 31 ～ 32 2 バイトの 2 進数で表される国別コード
33 ～ 35 34 ～ 36 予約済み

戻りコード

以下のコードが定義されています。

戻りコード 説明
0 Query System 関数は正常終了し、データ・ストリングが戻されました。
1 EHLLAPI がロードされていません。 (PC/3270 のみ)
2 ストリング長が正しくありません。 (PC/3270 のみ)
9 システム・エラーが発生しました。

使用上の注意

この関数を使用するには、戻りデータ・ストリング・パラメーターを受け入れるメモリーを事前に割り振ります。詳細については、メモリー割り振りを参照してください。

Query Window Coordinates (103)


3270 5250 VT
YES YES YES

Query Window Coordinates 関数は、ホスト表示スペースのウィンドウに対する座標を要求します。ウィンドウは座標レベルで戻されます。

注:
(0,0) はウィンドウの最上部左方を示しています。

前提呼び出し

Connect Window Services (101)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 103 にしてください。
データ・ストリング ホスト表示スペースの 1 文字の短縮セッション ID。
長さ 17 が暗黙指定されます。 20 が暗黙指定されます。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張
1 1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名 (PSID)
  • 現在接続されている表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
2 ～ 17 5 ～ 20 予約済み

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

バイト位置 定義
標準 拡張  
1 1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮セッション ID
  • 現在接続されている表示スペースに対する関数呼び出しを示す、ブランクまたは NULL 文字
2 ～ 4 予約済み
2 ～ 17 5 ～ 20 以下を戻す 32 ビット符号なし整数。
2 ～ 5 5 ～ 8 XLeft -- デスクトップ・ウィンドウに対する長方形ウィンドウの左部 X 座標の 32 ビット符号なし整数 (単位: ペル)
6 ～ 9 9 ～ 12 YBottom -- デスクトップ・ウィンドウに対する長方形ウィンドウの下部 Y 座標の 32 ビット符号なし整数 (単位: ペル)
10 ～ 13 13 ～ 15 XRight -- デスクトップ・ウィンドウに対する長方形ウィンドウの右部 X 座標の 32 ビット符号なし整数 (単位: ペル)
14 ～ 17 16 ～ 20 YTop -- デスクトップ・ウィンドウに対する長方形ウィンドウの上部 Y 座標の 32 ビット符号なし整数 (単位: ペル)

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Query Window Coordinates 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
9 システム・エラーが発生しました。
12 セッションが停止しました。

Read Structured Fields (126)


3270 5250 VT
YES NO NO

Read Structured Fields 関数を使用して、アプリケーションはホスト・アプリケーションから構造化フィールド・データを読み取ります。呼び出しで S (同期) を指定した場合、Read Structured Fields が完了するまで、アプリケーションに制御が戻されます。呼び出しで A (非同期) を指定した場合、その呼び出しの直後に、アプリケーションに制御が戻されます。呼び出しで M (非同期メッセージ・モード) を指定した場合、その呼び出しの直後に、アプリケーションに制御が戻されます。アプリケーションは、このメッセージを待ちます。いずれの場合 (S、A、または M) でも、アプリケーションにより、ホストからのデータが入るバッファー・アドレスが設定されます。

この関数が非同期に正常終了するためには、以下のステートメントを適用します。

パラメーター・リストの戻りコード・フィールドには、要求された入出力の結果が含まれていない場合もあります。戻りコードが 0 でない場合、要求は失敗しています。アプリケーションでは、戻りコードに応じて、適切な処置を行わなければなりません。

この要求に対する戻りコードが 0 である場合、アプリケーションで、この関数呼び出しと共に戻される要求 ID を使用して、 Get Request Completion 関数呼び出しを発行し、その要求 ID に関連する関数が終了したかどうかを判別します。 Get Request Completion 関数呼び出しによって、以下の情報が戻されます。

  1. 関数要求 ID
  2. 非同期要求からのデータ・ストリング・アドレス
  3. データ・ストリングの長さ
  4. 完了した関数の戻りコード

前提呼び出し

Connect for Structured Fields (120) および Allocate Communication Buffer (123)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 126 にしてください。
データ・ストリング 次の表を参照してください。
長さ 8、10、14 のいずれかにしてください。 20
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。


バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 4 予約済み。
2 5 S、A、M のいずれか

S =
同期。制御は、読み取りが満たされるまでアプリケーションに戻りません。

A =
非同期。制御は、アプリケーション (イベント・オブジェクト待機可能) に即時に戻されます。

M =
非同期。制御は、アプリケーション (メッセージ待機可能) に即時に戻されます。
6 予約済み。
3 ～ 4 7 ～ 8 2 バイトの Destination/Origin ID
5 ～ 8 9 ～ 12 データが読み取られる 4 バイトのバッファー・アドレス。 Allocate Communications Buffer (123) 関数を使用してバッファーを取得する必要があります。
9 ～ 10 13 ～ 16 予約済み。
11 ～ 12 17 ～ 20 バイト位置 2 に M を指定した場合、メッセージを受け取るウィンドウのウィンドウ・ハンドルを設定してください。メッセージは、RegisterWindowMessage ("PCSHLL") の戻り値 (0 以外) です。
13 ～ 14 この位置にあるデータは EHLLAPI で無視されます。ただし、移行プログラムでこの位置にデータを指定していても、エラーは発生しません。このデータはアプリケーションの移行時に互換性を保つために設けられています。

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
A (非同期) を位置 5 (標準インターフェースの場合は位置 2) に指定して、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
標準 拡張  
9 ～ 10 13 ～ 14 2 バイトの関数要求 ID。この関数要求 ID は、この関数呼び出しの完了を判別するために Get Request Completion (125) 関数で使用します。
15 ～ 16 予約済み。
17 ～ 20 EHLLAPI によってイベント・オブジェクト・アドレスが戻される 4 バイト値。アプリケーションは、このイベント・オブジェクトを待ちます。イベント・オブジェクトがクリアされたときに、アプリケーションは Get Request Completion (125) 関数呼び出しを発行しなければなりません (32 ビットの場合のみ)。
注:
イベント・オブジェクト・アドレスは、非同期要求が正常終了するたびに戻されます。イベント・オブジェクトは再使用しないでください。要求ごとに新しいイベント・オブジェクトが戻され、そのイベント・オブジェクトはその要求の間だけ有効です。

データ・ストリング:
"M" (非同期メッセージ・モード) をバイト位置 5 (16 ビットのアプリケーションの場合は 2) に指定して、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
9 ～ 10 13 ～ 14 2 バイトの関数要求 ID。この関数要求 ID は、この関数呼び出しの完了を判別するために Get Request Completion (125) 関数で使用します。
15 ～ 16 予約済み。
11 ～ 12 17 ～ 18 非同期メッセージ・モードのタスク ID。
19 ～ 20 予約済み。
注:
関数が正常終了した場合、アプリケーション・ウィンドウはメッセージを受け取ります。メッセージは、RegisterWindowMessage(PCSHLL) の戻り値です。wParam パラメーターには、関数呼び出しによって戻されたタスク ID が入ります。 lParam パラメーターの HIWORD には戻りコード 0 (関数の正常終了) が、LOWORD には関数番号 126 が入ります。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Read Structured Fields 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
11 リソースが使用できません。(メモリーが使用できません。)
35 要求はリジェクトされました。ホストからのアウトバウンド送信が取り消されました。
36 要求はリジェクトされました。ホストと接続できません。
37 関数は正常終了しましたが、ホストでのインバウンド送信が使用できません。

使用上の注意

  1. 戻りコード 35。これは、ホストからのアウトバウンド送信が取り消された後に Read Structured Fields または Write Structured Fields が要求された場合に戻されます。アプリケーションで修正処置を行う必要があります。
  2. 戻りコード 36。この場合、アプリケーションをエミュレーション・プログラムから切断してから再接続して、ホストとの通信を再確立する必要があります。アプリケーションで修正処置を行う必要があります。
  3. 戻りコード 37。これはホスト・インバウンドが使用不可の場合に戻されます。Read Structured Fields 関数は正常に要求されました。
  4. EHLLAPI では、アプリケーションごとに 20 までの非同期要求を未処理にすることができます。 20 を超える非同期要求が試行されると、リソースが使用不可であることを示す戻りコード (RC=11) が戻されます。
  5. IBM グローバル・ネットワーク(R)接続を使用する場合、非同期要求の最大数は 10 です。

構造化フィールド・データには、ホストからのアプリケーション構造化フィールドが含まれています。構造化フィールド・データがアプリケーションに達する前に、 EHLLAPI が構造化フィールド・ヘッダーを除去します。

構造化フィールド・データの形式は以下のとおりです。

オフセット 長さ 内容
0 1 ワード X'0000'
2 1 ワード m (メッセージの長さ。すなわち、メッセージ中のデータのバイト数。この数は 8 バイトを含むメッセージ・ヘッダーの接頭部を除いたものです)。EHLLAPI がこの値を戻します。
4 1 ワード n (バッファー・サイズ。すなわち、8 バイトのメッセージ・ヘッダーを除くデータ・バッファーの長さを示します)。この値は、アプリケーションが設定する必要があります。
6 1 ワード X'C000'
8 8 バイト 先頭の (または唯一の) 構造化フィールド・メッセージの長さ。
10 1 バイト 構造化フィールド・メッセージの長さ以外の最初のバイト。



·
·
·
m+7 1 バイト 構造化フィールド・メッセージの末尾のバイト。

バイト 0 から 7 は、バッファー・ヘッダーです。最初のこれらの 8 バイトは、エミュレーション・プログラムで使用されます。バッファーのユーザー・セッションは、オフセット 8 からです。バイト 8 および 9 は、最初の構造化フィールド (構造化フィールド・メッセージには複数の構造化フィールドを含むことができます) 内のバイト数が入っています (バイト 8 および 9 に対する 2 バイトなど)。バイト 8 から m +7 は、構造化フィールド・メッセージがホスト (複数の構造化フィールドを入れることができます) から戻される場所です。

使用中のアプリケーションは、オフセット 0 のワードを 0 に設定して、完全なバッファーを提供しなければなりません。バッファー長は、オフセット 4 のワードになければなりません。オフセット 6 のワードは X'C000' にする必要があります。エミュレーション・プログラムは、データ・メッセージをオフセット 8 から入れ、メッセージの長さをオフセット 2 のワードに入れます。バッファー長は EHLLAPI により妨害されません。

同期要求

Read Structured Fields が同期要求 (データ・ストリング中の S オプション) された際には、制御は要求が満たされた後に限りアプリケーションに戻されます。アプリケーションでは以下のことを想定できます。

非同期要求

Read Structured Fields が非同期要求 (データ・ストリング中の A オプション) された際には、アプリケーションでは以下のことを想定できません。

非同期要求がなされた際には、EHLLAPI は以下の値を戻します。

これらは、非同期の Read Structured Fields 呼び出しを完了させるために使用します。

非同期の Read Structured Fields 関数呼び出しの結果を判別するためには、次のステップを行わなければなりません。

Read Structured Fields が非同期要求 (データ・ストリング中の M オプション) された際には、アプリケーションでは以下のことを想定できません。

M オプションを指定して非同期要求がなされた際には、EHLLAPI は以下の値を戻します。

これらは、非同期の Read Structured Fields 呼び出しを完了させるために使用します。

Receive File (91)


3270 5250 VT
YES YES NO

Receive File 関数は、ファイルをホストのセッションからワークステーションのセッションへ転送する際に使用します。この機能の使用方法は、PC/3270 における RECEIVE コマンドと同様です。 Receive File 関数は EHLLAPI アプリケーション・プログラムによって呼び出すことができます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 91 にしてください。
データ・ストリング 以下の例を参照してください。
長さ データ・ストリングの長さ (バイト数)。 EOT モードの場合、このパラメーターは一時変更されます。

1 バイト文字セット (SBCS) のデータ・ストリングの例を以下に示します。

3270 セッション

5250 セッション

2 バイト文字セット (DBCS) のデータ・ストリングの例を以下に示します。

3270 セッション

5250 セッション

注:
[ ] で囲まれたパラメーターはオプションです。指定できるオプションは、次の表のとおりです。

ホスト・システム 共通オプション
VM/CMS ASCII、ASCII、CRLF、APPEND、TIME n、CLEAR、NOCLEAR、 PROGRESS、QUIET
MVS/TSO ASCII、ASCII、CRLF、APPEND、TIME (n)、CLEAR、NOCLEAR、 PROGRESS、QUIET、AVBLOCK|TRACKS|CYLINDERS
CICS ASCII、ASCII、CRLF、NOCRLF、BINARY、TIME n、CLEAR、 NOCLEAR、PROGRESS、QUIET
i5/OS(TM) または OS/400(R) ASCII、ASCII、CRLF、APPEND、TIME n、CLEAR、NOCLEAR、 PROGRESS、QUIET
注:
ASCII は日本の DBCS セッションでのみ有効であり、ASCII は、その他すべての SBCS セッションと DBCS セッションで有効です。

指定されたその他のオプションは、ホスト転送プログラムに渡されます。ホスト側のファイル転送プログラムは、これらを使用するか、無視するか、エラーを戻すかのいずれかです。ホスト転送プログラムのマニュアルで、サポートされるオプションの完全なリストを調べてください。

戻りパラメーター


戻りコード 説明
2 パラメーター・エラーが発生したか、または EHLLAPI バッファーに対して長すぎる (255 バイトを超過) データ・ストリング長が指定されました。ファイル転送が失敗しました。
3 ファイル転送は完了しました。
4 ファイル転送は完了し、レコードは分割されました。
9 システム・エラーが発生しました。
27 Cancel ボタンまたはタイムアウト (Set Session Parameter (9) 関数により設定) によってファイル転送は終了しました。
101 ファイル転送 (CICS への/CICS からの転送) は正常に終了しました。

システム内、またはユーザーのデータ・ストリングの指定方法に問題がある場合には、戻りコード 2 または 9 が戻されます。

他の戻りコードも受信される場合があります。これらの戻りコードは、ホスト転送プログラムにより生成されるメッセージ番号に関連しています。CICS ホスト転送プログラムに転送する場合、その戻りコードから 100 を減算するとメッセージの数値部分を得ることができます。例えば、戻りコードが 101 の場合には、ホストによりメッセージ番号 INW0001 が出されたことを示します。他のホスト転送プログラムの場合には、そのメッセージの数字部分のみ使用してください。例えば、戻りコードが 34 の場合には、ホストによりメッセージ番号 TRANS34 が出されたことを示します。特定のメッセージの意味については、ご使用のホスト転送プログラムの資料を参照してください。

EHLLAPI により報告されたオペレーティング・システムのエラー・コードは、300 より大きい数字です。エラー・コードを判別するには、300 を引いてから、オペレーティング・システムの資料でその戻りコードを調べてください。

使用上の注意

  1. Set Session Parameters (9) 関数での 4 つのパラメーター・セットがこの関数に関連しています。それらは STRLEN/STREOT、EOT=c、QUIET/NOQUIET および TIMEOUT=c/TIMEOUT=0 の各セッション・オプションです。詳細については、 1、 2、 7 および 8 を参照してください。
  2. Receive File 関数を実行時にパスを指定しない場合、受信されたファイルは現行のサブディレクトリーに保管されます。このサブディレクトリーは、ユーザーのアプリケーションが実行されているディレクトリーです。

Release (12)


3270 5250 VT
YES YES YES

Release 関数は、Reserve (11) 関数により予約されている表示スペースに関連するキーボードをアンロックします。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 12 にしてください。
データ・ストリング NA
長さ NA
PS 位置 NA

戻りパラメーター


戻りコード 説明
0 Release 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
9 システム・エラーが発生しました。

使用上の注意

Release (11) 関数で予約されているホストの表示スペースに対して Reserve 関数を使用しないと、Reset System (21) 関数または Disconnect Presentation Space (2) 関数を呼び出すか、EHLLAPI アプリケーション・プログラムを終了させるまで、ユーザーはセッションからロックアウトされます。

Reserve (11)


3270 5250 VT
YES YES YES

Reserve 関数は、端末オペレーターからのブロック入力に対するホスト接続表示スペースに関連するキーボードをロックします。

予約済みのホスト表示スペースは、次のいずれかが発生するまでロック状態を維持します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 11 にしてください。
データ・ストリング NA
長さ NA
PS 位置 NA

戻りパラメーター


戻りコード 説明
0 Reserve 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
5 表示スペースの使用が禁止されています。
9 システム・エラーが発生しました。

使用上の注意

  1. EHLLAPI アプリケーション・プログラムで一連のトランザクションをホストへ送信するとき、アプリケーションの処理が終了するまで、そのセッションに対するアクセスを阻止する必要があります。
  2. この関数でキーボードがロックされている間にユーザーが行ったキーボード入力はキューに入り、セッション終了後に処理されます。
  3. この関数は、マウス入力とキーボード入力の両方をロックします。マウス入力またはキーボード入力を使用可能にするためには、アプリケーション・プログラムで表示スペースをアンロックする必要があります。

Reset System (21)


3270 5250 VT
YES YES YES

Reset System 関数は、EHLLAPI を開始状態に初期化し直します。セッションのパラメーター・オプションはデフォルト値にリセットされます。イベント通知は停止します。予約済みのホスト・セッションは解放されます。ホスト表示スペースは切断されます。キー・ストロークの代行受信は使用不可になります。

Reset System 関数は、初期化時またはプログラム終了時にシステムの既知の初期化状態にリセットするために使用できます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 21 にしてください。
データ・ストリング NA
長さ NA
PS 位置 NA

戻りパラメーター


戻りコード 定義
0 Reset System 関数は正常終了されました。
1 EHLLAPI がロードされていません。
9 システム・エラーが発生しました。

使用上の注意

PC/3270 では、EHLLAPI がロードされているかどうかを確認するために、この関数を使用できます。アプリケーション開始時にこの関数を呼び出し、戻りコードが 1 かどうかを確認してください。

Search Field (30)


3270 5250 VT
YES YES YES

Search Field 関数は、指定されたストリングの存在について、接続されたホストの表示スペースのフィールドを検索します。ターゲット・ストリングが検出された場合、この関数はホスト表示スペースの先頭から数えたストリングの位置を 10 進数で戻します。 (例えば、24 行 80 桁の表示スペースでは、行 1 桁 1 の位置は番号 1 になり、行 5 桁 1 の位置は番号 321 になります。)

この関数は、 フィールド形式 のホスト表示スペース内のフィールドに限り、保護フィールドまたは無保護フィールドを検索するために使用することができます。

注:
フィールドがホスト表示スペースの終わりで折り返している場合、表示スペースの終わりに到達したときに折り返します。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 30 にしてください。
データ・ストリング 検索するデータ・ストリング。
長さ 該当データ・ストリングの長さ。 EOT モードの場合、このパラメーターは一時変更されます。
PS 位置 該当フィールドを識別します。 SRCHALL に対しては、このパラメーターは該当フィールド内のどのバイトの PS 位置でも構いません。 SRCHFROM に対しては、このパラメーターは SRCHFRWD 検索の開始位置または SRCHBKWD の終了位置を示します。 3 の使用上の注意を参照してください。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
以下のコードが定義されています。

長さ 説明
= 0 ストリングが検出されませんでした。
> 0 示されたホスト表示スペースの位置でストリングが検出されました。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Search Field 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター・エラーです。ストリング長が 0 か、または EOT モードが指定されましたが、呼び出しデータ・ストリング内に EOT 文字がありません。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 検索ストリングが検出されなかったか、またはホストの表示スペースが定様式化されていません。

使用上の注意

  1. Set Session Parameters (9) 関数での 4 つのパラメーター・セットがこの関数に関連しています。それらは SRCHALL/SRCHFROM、STRLEN/STREOT、 SRCHFRWD/SRCHBKWD、および EOT=c の各セッション・オプションです。詳細については、 1 ～ 4 を参照してください。
  2. Set Session Parameters (9) 関数を使用して、ユーザーは検索をフィールドの先頭から終わりに向かって実行するのか (SRCHFRWD) またはその逆方向に実行するのか

    (SRCHBKWD) を決定することができます。

  3. Search Field 関数は通常フィールド内全体をチェックします (SRCHALL がデフォルト・モードです)。しかし、機能 9 を使用して SRCHFROM を指定することができます。このモードでは、呼び出し PS 位置パラメーターは、該当フィールドの識別以外のことも実行します。つまり、検索の開始点または終了点も指定します。
  4. DBCS の場合のみ: 指定した検索関数の開始位置が 2 バイト文字の第 2 バイトである場合、検索は SRCHFRWD のときは次の文字から、SRCHBKWD の時はその文字から開始されます。指定したストリングの最後の文字が 2 バイト文字の第 1 バイトである場合、その文字は検索対象となりません。

    検索時には、表示スペース内では SO と SI の対は無視されます。 2 バイト制御文字を検索するには、その文字の前後に SO (X'0E') と SI (X'0F') を付けてください。例えば、データ・ストリング内の X'0E000C0F' は 2 バイト文字 FF

    (X'000C') として扱われます。

注:
5250 エミュレーションは、24 行 80 桁の表示スペースをサポートします。コミュニケーション・マネージャー 5250 エミュレーションが 25 番目の行を表示するインスタンスもあります。このようなことが起こるのは、ホストからのエラー・メッセージが表示される場合、またはオペレーターが SysReq キーを選択する場合です。パーソナル・コミュニケーションズは、25 行目の情報を 24 行目またはステータス・バーに表示します。ステータス・バーに情報が表示される場合は、ステータス・バーがその情報用に構成されている必要があります。ステータス・バーの構成方法の詳細については、「はじめに」を参照してください。EXTEND_PS オプションによって、EHLLAPI アプリケーションはコミュニケーション・マネージャー EHLLAPI と同じインターフェースを使用することができ、このような状況が発生したときに有効な表示スペースが拡張されます。

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 30 にしてください。
データ・ストリング 検索対象のターゲット・ユニコード・ストリング。
長さ ユニコード文字でのターゲット・ユニコード・ストリングの長さ。

注:
EOT モードはユニコード・セッションではサポートされていません。したがって、ユニコード・セッションでこの関数が正しく機能するように長さを指定する必要があります。
PS 位置 該当フィールドを識別します。 SRCHALL に対しては、このパラメーターは該当フィールド内のどのバイトの PS 位置でも構いません。 SRCHFROM に対しては、このパラメーターは SRCHFRWD 検索の開始位置または SRCHBKWD の終了位置を示します。 3 の使用上の注意を参照してください。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
以下のコードが定義されています。

長さ 説明
= 0 ストリングが検出されませんでした。
> 0 示されたホスト表示スペースの位置でストリングが検出されました。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Search Field 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター・エラーです。ストリング長が 0 か、または EOT モードが指定されましたが、呼び出しデータ・ストリング内に EOT 文字がありません。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 検索ストリングが検出されなかったか、またはホストの表示スペースが定様式化されていません。

使用上の注意

以下のオプションは Search Field のユニコード・セッションでサポートされ、DBCS の場合と同じ方法で機能します。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 30 にしてください。
データ・ストリング 検索対象のターゲット・ユニコード・ストリング。
長さ バイト単位でのターゲット・ユニコード・ストリングの長さ。

注:
EOT モードはユニコード・セッションではサポートされていません。したがって、ユニコード・セッションでこの関数が正しく機能するように長さを指定する必要があります。
PS 位置 該当フィールドを識別します。 SRCHALL に対しては、このパラメーターは該当フィールド内のどのバイトの PS 位置でも構いません。 SRCHFROM に対しては、このパラメーターは SRCHFRWD 検索の開始位置または SRCHBKWD の終了位置を示します。 3 の使用上の注意を参照してください。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
以下のコードが定義されています。

長さ 説明
= 0 ストリングが検出されませんでした。
> 0 示されたホスト表示スペースの位置でストリングが検出されました。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Search Field 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター・エラーです。ストリング長が 0 か、または EOT モードが指定されましたが、呼び出しデータ・ストリング内に EOT 文字がありません。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 検索ストリングが検出されなかったか、またはホストの表示スペースが定様式化されていません。

使用上の注意

以下のオプションは Search Field のユニコード・セッションでサポートされ、SBCS の場合と同じ方法で機能します。

Search Presentation Space (6)


3270 5250 VT
YES YES YES

Search Presentation Space 関数により、 EHLLAPI プログラムは指定されたストリングの存在についてホストの表示スペースをチェックします。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 6 にしてください。
データ・ストリング 検索するデータ・ストリング。
長さ 該当データ・ストリングの長さ。 EOT モードの場合、このパラメーターは一時変更されます。
PS 位置 ホスト・プレゼンテーション内の、検索を開始する (SRCHFRWD オプション) 位置、または検索を終了する (SRCHBKWD オプション) 位置。SRCHALL (デフォルト) モードの場合、このパラメーターは一時変更されます。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
以下のコードが定義されています。

長さ 説明
= 0 ストリングが検出されませんでした。
> 0 示されたホスト表示スペースの位置でストリングが検出されました。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Search Presentation Space 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター指定でエラーが発生しました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 検索ストリングが検出されませんでした。

使用上の注意

  1. Set Session Parameters (9) 関数での 4 つのパラメーター・セットがこの関数に関連しています。それらは SRCHALL/SRCHFROM、STRLEN/STREOT、 SRCHFRWD/SRCHBKWD、および EOT=c の各セッション・オプションです。詳細については、 1 ～ 4 を参照してください。

  2. Set Session Parameters (9) 関数を使用して、 SRCHBKWD を指定することができます。このオプションが有効である場合、検索操作はストリングの最後 の出現位置を検出します。
  3. Search Presentation Space 関数は、通常、全ホスト表示スペースをチェックします。しかし、Set Session Parameters (9) 関数を使用して SRCHFROM を指定することができます。このモードのとき、PS 位置パラメーターは検索の開始位置または検索の終了位置を指定します。
  4. ホスト表示スペース内に複数回出現する可能性のあるキーワードを検索する場合には SRCHFROM オプションも使用できます。
  5. Search Presentation Space 関数は、ホスト表示スペースが使用可能かどうかの判別にも使用できます。ユーザーの EHLLAPI アプリケーション・プログラムがデータ送信の前に特定のプロンプトまたはメッセージを要求している場合、 Search Presentation Space 関数を使用して、処理続行の前にプロンプトまたはメッセージをチェックすることができます。
  6. DBCS の場合のみ: 指定した検索関数の開始位置が 2 バイト文字の第 2 バイトである場合、検索は SRCHFRWD のときは次の文字から、SRCHBKWD の時はその文字から開始されます。指定したストリングの最後の文字が 2 バイト文字の第 1 バイトである場合、その文字は検索対象となりません。

    検索時には、表示スペース内では SO と SI の対は無視されます。 2 バイト制御文字を検索するには、その文字の前後に SO (X'0E') と SI (X'0F') を付けてください。例えば、データ・ストリング内の X'0E000C0F' は 2 バイト文字 FF

    (X'000C') として扱われます。

注:
5250 エミュレーションは、24 行 80 桁の表示スペースをサポートします。コミュニケーション・マネージャー 5250 エミュレーションが 25 番目の行を表示するインスタンスもあります。このようなことが起こるのは、ホストからのエラー・メッセージが表示される場合、またはオペレーターが SysReq キーを選択する場合です。パーソナル・コミュニケーションズは、25 行目の情報を 24 行目またはステータス・バーに表示します。ステータス・バーに情報が表示される場合は、ステータス・バーがその情報用に構成されている必要があります。ステータス・バーの構成方法の詳細については、「はじめに」を参照してください。EXTEND_PS オプションによって、EHLLAPI アプリケーションはコミュニケーション・マネージャー EHLLAPI と同じインターフェースを使用することができ、このような状況が発生したときに有効な表示スペースが拡張されます。

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 6 にしてください。
データ・ストリング 検索対象のターゲット・ユニコード・ストリング。
長さ ユニコード文字でのターゲット・ユニコード・ストリングの長さ。

注:
EOT モードはユニコード・セッションではサポートされていません。したがって、ユニコード・セッションでこの関数が正しく機能するように長さを指定する必要があります。
PS 位置 ホスト・プレゼンテーション内の、検索を開始する (SRCHFRWD オプション) 位置、または検索を終了する (SRCHBKWD オプション) 位置。SRCHALL (デフォルト) モードの場合、このパラメーターは一時変更されます。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
以下のコードが定義されています。

長さ 説明
= 0 ストリングが検出されませんでした。
> 0 示されたホスト表示スペースの位置でストリングが検出されました。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Search Presentation Space 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター指定でエラーが発生しました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 検索ストリングが検出されませんでした。

使用上の注意

以下のオプションは Search Presentation Space (6) のユニコード・セッションでサポートされ、DBCS の場合と同じように機能します。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 6 にしてください。
データ・ストリング 検索対象のターゲット・ユニコード・ストリング。
長さ バイト単位でのターゲット・ユニコード・データ・ストリングの長さ。

注:
EOT モードはユニコード・セッションではサポートされていません。したがって、ユニコード・セッションでこの関数が正しく機能するように長さを指定する必要があります。
PS 位置 ホスト・プレゼンテーション内の、検索を開始する (SRCHFRWD オプション) 位置、または検索を終了する (SRCHBKWD オプション) 位置。SRCHALL (デフォルト) モードの場合、このパラメーターは一時変更されます。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
以下のコードが定義されています。

長さ 説明
= 0 ストリングが検出されませんでした。
> 0 示されたホスト表示スペースの位置でストリングが検出されました。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Search Presentation Space 関数は正常終了しました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター指定でエラーが発生しました。
7 ホスト表示スペースの位置が正しくありません。
9 システム・エラーが発生しました。
24 検索ストリングが検出されませんでした。

使用上の注意

以下のオプションは Search Presentation Space (6) のユニコード・セッションでサポートされ、SBCS の場合と同じように機能します。

Send File (90)


3270 5250 VT
YES YES NO

Send File 関数は、EHLLAPI を実行しているワークステーションのセッションからホストのセッションへファイルを転送するときに使用します。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 90 にしてください。
データ・ストリング 以下の例を参照してください。
長さ 該当データ・ストリングの長さ。 EOT モードの場合、このパラメーターは一時変更されます。
PS 位置 必ず 0 にしてください。

SBCS のデータ・ストリングの例を以下に示します。

3270 セッション

5250 セッション

DBCS のデータ・ストリングの例を以下に示します。

3270 セッション

5250 セッション

注:
[ ] で囲まれたパラメーターはオプションです。指定できるオプションは、次の表のとおりです。オプションについて詳しくは、「管理者ガイドおよび解説書」を参照してください。

ホスト・システム 共通オプション
VM/CMS ASCII、ASCII、CRLF、APPEND、LRECL n、RECFM v|f、TIME n、 CLEAR、NOCLEAR、PROGRESS、QUIET
MVS/TSO ASCII、JISCII、CRLF、APPEND、LRECL (n)、RECFM (v|f|u)、TIME (n)、CLEAR、NOCLEAR、PROGRESS、QUIET、BLKSIZE (n)、SPACE (n[,m])、AVBLOCK|TRACKS|CYLINDERS
CICS ASCII、ASCII、CRLF、BINARY、TIME n、CLEAR、NOCLEAR、 PROGRESS、QUIET
i5/OS または OS/400 ASCII、ASCII、CRLF、APPEND、SRC、LRECL n、TIME n、 CLEAR、NOCLEAR、PROGRESS、QUIET
注:

ASCII は日本の DBCS セッションでのみ有効であり、ASCII は、その他すべての SBCS セッションと DBCS セッションで有効です。

注:
時刻を指定すると、その値が Set Session パラメーターの値に取って代わります。

注:

指定されたその他のオプションは、ホスト転送プログラムに渡されます。ホスト側のファイル転送プログラムは、これらを使用するか、無視するか、エラーを戻すかのいずれかです。ホスト転送プログラムのマニュアルで、サポートされるオプションの完全なリストを調べてください。

戻りパラメーター


戻りコード 説明
2 パラメーター・エラーが発生したか、または EHLLAPI バッファーに対して長すぎる (255 バイトを超過) データ・ストリング長が指定されました。ファイル転送が失敗しました。
3 ファイル転送は完了しました。
4 ファイル転送は完了し、レコードは分割されました。
5 ワークステーション・ファイル名が有効でなかったか、見つかりませんでした。ファイル転送が取り消されました。
9 システム・エラーが発生しました。
27 Cancel ボタンまたはタイムアウト (Set Session Parameter (9) 関数により設定) によってファイル転送は終了しました。
101 ファイル転送 (CICS への/CICS からの転送) は正常に終了しました。

システム内、またはユーザーのデータ・ストリングの指定方法に問題がある場合には、戻りコード 2 または 9 が戻されます。

他の戻りコードも受信される場合があります。これらの戻りコードは、ホスト転送プログラムにより生成されるメッセージ番号に関連しています。CICS ホスト転送プログラムに転送する場合、その戻りコードから 100 を減算するとメッセージの数値部分を得ることができます。例えば、戻りコードが 101 の場合には、ホストによりメッセージ番号 INW0001 が出されたことを示します。他のホスト転送プログラムの場合には、そのメッセージの数字部分のみ使用してください。例えば、戻りコードが 34 の場合には、ホストによりメッセージ番号 TRANS34 が出されたことを示します。特定のメッセージの意味については、ご使用のホスト転送プログラムの資料を参照してください。

EHLLAPI により報告されたオペレーティング・システムのエラー・コードは、300 より大きい数字です。エラー・コードを判別するには、300 を引いてから、オペレーティング・システムの資料でその戻りコードを調べてください。

使用上の注意

  1. Set Session Parameters (9) 関数での 4 つのパラメーター・セットがこの関数に関連しています。それらは QUIET/NOQUIET、STRLEN/STREOT、 TIMEOUT=c/TIMEOUT=0、および EOT=c の各セッション・オプションです。詳細については、 1 と、 2、 7 および 8 の項目を参照してください。

Send Key (3)


3270 5250 VT
YES YES YES

Send Key 関数は、1 つのキー・ストロークまたはキー・ストロークのストリングをホスト表示スペースへ送信する際に使用します。

呼び出しデータ・ストリング・パラメーターで、送信するキー・ストロークのストリングを定義します。キー・ストロークは、端末オペレーターが入力したかのように、宛先セッションには見えます。 Enter などのアテンション ID (AID) キーもすべて送信できます。ホストの入力保護フィールドまたは数字専用フィールドはすべて、それに対応した取り扱いが必要です。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 3 にしてください。
データ・ストリング キー・ストロークのストリング。最大 255 バイト。英大文字と英小文字の ASCII 文字は、そのまま表されます。ファンクション・キーおよびシフト・ファンクション・キーは、略号によって表されます。 キーボードの略号を参照してください。
長さ 送信元データ・ストリングの長さ。 EOT モードの場合、このパラメーターは一時変更されます。
PS 位置 NA

戻りパラメーター


戻りコード 説明
0 キー・ストロークは送信され、状況は正常です。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 無効なパラメーターが EHLLAPI に渡されました。
4 ホスト・セッションは使用中であったため、どのキー・ストロークも送信できませんでした。
5 送信先セッションへの入力が禁止または拒否されたため、キー・ストローク全部を送信することはできませんでした。
9 システム・エラーが発生しました。

使用上の注意

  1. Set Session Parameters (9) 関数のパラメーターがこの関数に関連しています。それらは AUTORESET/NORESET、 STRLEN/STREOT、EOT=c、ESC=c、および RETRY/NORETRY の各セッション・オプションです。詳細については、 1 と 2、 9 と 10、および 19 の項目を参照してください。

  2. キーボードがロックされていたり、使用中の時は、キー・ストロークをホスト・セッションへ送信することはできません。 Wait (4) 関数でキーボードの状態をチェックすることができます。
  3. ホストが使用中の場合、入力が拒否されることがあります。
  4. データ・ストリングの長さは、デフォルトのデータ・ストリング長パラメーターを使用して明示的に定義する必要があります。しかし、Set Session Parameters (9) 関数の EOT=c オプションで暗黙的に定義することもできます。

    データ・ストリング長を明示的に定義する場合 (1 を参照)、アプリケーションが渡すデータ・ストリング長パラメーターの値を計算しなければなりません。この計算では、@E などの複合キー・ストロークは 2 バイト、 @A@C などの複合キー・ストロークは 4 バイトとします。

  5. 特殊制御キーを送信するには、複合文字によるコーディング法を使用します。このコーディング法では、1 つのキー・ストロークを示すために 2 から 4 文字の ASCII 文字が使用されています。 1 番目と 3 番目の文字は常にエスケープ文字です。 2 番目と 4 番目の文字は常にキー・コードです。

    シーケンス LOGON ABCDE の後に Enter (改行) キーを押す場合は、ストリングを LOGON ABCDE@E とコーディングします。これらのキー・コードの完全なリストは、キーボードの略号にあります。

    この複合コーディング法により、複雑な 16 進キー・コードを使用せずに必要なすべてのキー・ストローク・コードの ASCII ストリング表現が可能になります。

    デフォルトのエスケープ文字は @ です。エスケープ文字の値は、Set Session Parameters (9) 関数の ESC=c オプションを使用して、別の文字に変更することができます。

  6. パフォーマンスを向上させる必要があるユーザーは、 Send Key (3) 関数でストロークを送信するよりも、 Copy String to Field (33) または Copy String to Presentation Space (15) 関数を使用してください。ただし、Send Key (3) 関数だけが特殊制御キーを送信することができます。
  7. この関数のパフォーマンスを向上させるためには、 Set Session Parameters (9) のセッション・オプション 10 (NORESET オプション) を参照してください。

    NORESET を指定しない場合には、リセットの略号がキー・ストローク・ストリングに接頭部として追加されます。したがって、入力禁止以外のリセット可能な状況はすべてリセットされます。

    NORESET オプションは Reset System (21) 関数と同じではありません。

  8. AID キーを含むキー・ストローク・ストリングは複数のパスを介してホストに送信されます。それぞれのパスは、最初の AID キー前までの (またはそれを含む) ストリングを送信します。 EHLLAPI は、ストリング長および各パスの開始位置を調整します。ホストのアプリケーション・プログラムによっては、任意のキー・ストロークが AID キー処理のために失われることがあります。したがって、複数の AID キーを含むキー・ストロークのリストを送信することはお勧めできません。
  9. @P (印刷) または @A@T (表示スペースの印刷) 処理中、その表示スペースを更新する要求はすべて拒否されます。印刷要求の最中に表示スペースが使用中状態だったり、割り込み要求が発生した場合には、略号 @A@R (装置リセット - 表示スペースの印刷の取り消し) が要求を取り消し、状況をリセットします。

キーボードの略号

キーボードの略号はワークステーションのキーボードの特殊ファンクション・キーを表す ASCII 文字を提供します。この省略形コードにより、これらの特殊キーが覚えやすくなります。最もよく使用されるキーは英字キー・コードです。例えば、Clear キーは C、Tab キーは T などです。

表 7 は英大文字を使用する略号の一覧です。

表 7. 英大文字による略号

略号 意味 3270 5250 VT
@B 左タブ YES YES NO
@C 消去 YES YES NO
@D 削除 YES YES NO
@E 実行 (Enter) YES YES NO
@F EOF 消去 YES YES NO
@H ヘルプ NO YES NO
@I 挿入 YES YES NO
@J ジャンプ (フォーカスを設定) YES YES NO
@L カーソル左移動 YES YES YES
@N 改行 YES YES YES
@O スペース YES YES YES
@P ページ印刷 YES YES YES
@R リセット YES YES NO
@T 右タブ YES YES YES
@U カーソル上移動 YES YES YES
@V カーソル下移動 YES YES YES
@X* DBCS (予約済み) YES YES NO
@Z カーソル右移動 YES YES YES

表 8 は数字または英小文字を使用する略号の一覧です。

表 8. 数字または英小文字による略号

略号 意味 3270 5250 VT
@0 カーソル・ホーム YES YES NO
@1 PF1/F1 YES YES NO
@2 PF2/F2 YES YES NO
@3 PF3/F3 YES YES NO
@4 PF4/F4 YES YES NO
@5 PF5/F5 YES YES NO
@6 PF6/F6 YES YES YES
@7 PF7/F7 YES YES YES
@8 PF8/F8 YES YES YES
@9 PF9/F9 YES YES YES
@a PF10/F10 YES YES YES
@b PF11/F11 YES YES YES
@c PF12/F12 YES YES YES
@d PF13 YES YES YES
@e PF14 YES YES YES
@f PF15 YES YES YES
@g PF16 YES YES YES
@h PF17 YES YES YES
@i PF18 YES YES YES
@j PF19 YES YES YES
@k PF20 YES YES YES
@l PF21 YES YES NO
@m PF22 YES YES NO
@n PF23 YES YES NO
@o PF24 YES YES NO
@q End YES YES NO
@u 前ページ NO YES NO
@v 次ページ NO YES NO
@x PA1 YES YES NO
@y PA2 YES YES NO
@z PA3 YES YES NO

表 9 は @A と @ 英大文字 (A～Z) キーの組み合わせを使用する略号の一覧です。

表 9. @A と @ 英大文字による略号

略号 意味 3270 5250 VT
@A@C テスト NO YES NO
@A@D ワード削除 YES YES NO
@A@E フィールド終了 YES YES NO
@A@F 入力消去 YES YES NO
@A@H システム要求 YES YES NO
@A@I 挿入切り替え YES YES NO
@A@J カーソル選択 YES YES NO
@A@L 高速カーソル左移動 YES YES NO
@A@Q アテンション YES YES NO
@A@R 装置の取り消し (表示スペース印刷取り消し) YES YES NO
@A@T 表示スペース印刷 YES YES YES
@A@U 高速カーソル上移動 YES YES NO
@A@V 高速カーソル下移動 YES YES NO
@A@Z 高速カーソル右移動 YES YES NO

表 10 は、@A と @ 数字、または @A と @ 英小文字 (a～z) キーの組み合わせを使用する略号の一覧です。

表 10. @A と @ 英小文字による略号

略号 意味 3270 5250 VT
@A@9 反転表示 YES YES NO
@A@b 下線 YES NO NO
@A@c 反転表示のリセット YES NO NO
@A@d 赤 YES NO NO
@A@e ピンク YES NO NO
@A@f 緑 YES NO NO
@A@g 黄 YES NO NO
@A@h 青 YES NO NO
@A@i 空色 YES NO NO
@A@j 白 YES NO NO
@A@l ホスト・カラーのリセット YES NO NO
@A@t 印刷 (ワークステーション) YES YES NO
@A@y 正方向ワード・タブ YES YES NO
@A@z 逆方向ワード・タブ YES YES NO

表 11 は @A と @ 特殊文字の組み合わせを使用する略号の一覧です。

表 11. @A と @ 特殊文字による略号

略号 意味 3270 5250 VT
@A@- フィールド - NO YES NO
@A@+ フィールド + NO YES NO
@A@< レコード・バックスペース NO YES NO

表 12 は @S と @ 英文字の組み合わせを使用する略号の一覧です。

表 12. @S (シフト) と @ 英文字による略号

略号 意味 3270 5250 VT
@S@E ホストでの表示スペース印刷 NO YES NO
@S@x 複写 (DUP) YES YES NO
@S@y フィールド・マーク YES YES NO

DBCS の場合のみ: 表 13 は @X と @ 数字または @X と @ 英小文字 (a～z) の組み合わせを使用する略号の一覧です。

表 13. @X と @ 英小文字による略号 (DBCS の場合のみ)

略号 意味 3270 5250 VT
@X@1 SO/SI 表示 YES YES NO
@X@5 SO/SI 生成 NO YES NO
@X@6 属性表示 NO YES NO
@X@7 文字前進 NO YES NO
@X@c 縦破線 NO YES NO

VT の場合のみ: 表 14 は、 @M と @ 数字または @M と @ 英小文字 (a ～ z) の組み合わせを使用する略号です。

表 14. @M、@Q、および @ 英小文字を使用した略号 (VT の場合のみ)

略号 意味 3270 5250 VT
@M@0 VT テン・キー 0 NO NO YES
@M@1 VT テン・キー 1 NO NO YES
@M@2 VT テン・キー 2 NO NO YES
@M@3 VT テン・キー 3 NO NO YES
@M@4 VT テン・キー 4 NO NO YES
@M@5 VT テン・キー 5 NO NO YES
@M@6 VT テン・キー 6 NO NO YES
@M@7 VT テン・キー 7 NO NO YES
@M@8 VT テン・キー 8 NO NO YES
@M@9 VT テン・キー 9 NO NO YES
@M@- VT テン・キー - (負符号) NO NO YES
@M@, VT テン・キー , (コンマ) NO NO YES
@M@. VT テン・キー . (ピリオド) NO NO YES
@M@e VT テン・キー Enter NO NO YES
@M@f VT 編集 検索 NO NO YES
@M@i VT 編集 挿入 NO NO YES
@M@r VT 編集 除去 NO NO YES
@M@s VT 編集 選択 NO NO YES
@M@p VT 編集 前の画面 NO NO YES
@M@n VT 編集 次の画面 NO NO YES
@M@a VT PF1 NO NO YES
@M@b VT PF2 NO NO YES
@M@c VT PF3 NO NO YES
@M@d VT PF4 NO NO YES
@M@h VT 保留画面 NO NO YES
@M@(スペース) 制御コード NUL NO NO YES
@M@A 制御コード SOH NO NO YES
@M@B 制御コード STX NO NO YES
@M@C 制御コード ETX NO NO YES
@M@D 制御コード EOT NO NO YES
@M@E 制御コード ENQ NO NO YES
@M@F 制御コード ACK NO NO YES
@M@G 制御コード BEL NO NO YES
@M@H 制御コード BS NO NO YES
@M@I 制御コード HT NO NO YES
@M@J 制御コード LF NO NO YES
@M@K 制御コード VT NO NO YES
@M@L 制御コード FF NO NO YES
@M@M 制御コード CR NO NO YES
@M@N 制御コード SO NO NO YES
@M@O 制御コード SI NO NO YES
@M@P 制御コード DLE NO NO YES
@M@Q 制御コード DC1 NO NO YES
@M@R 制御コード DC2 NO NO YES
@M@S 制御コード DC3 NO NO YES
@M@T 制御コード DC4 NO NO YES
@M@U 制御コード NAK NO NO YES
@M@V 制御コード SYN NO NO YES
@M@W 制御コード ETB NO NO YES
@M@X 制御コード CAN NO NO YES
@M@Y 制御コード EM NO NO YES
@M@Z 制御コード SUB NO NO YES
@M@u 制御コード ESC NO NO YES
@M@v 制御コード FS NO NO YES
@M@w 制御コード GS NO NO YES
@M@x 制御コード RS NO NO YES
@M@y 制御コード US NO NO YES
@M@z 制御コード DEL NO NO YES
@Q@A VT ユーザー定義キー 6 NO NO YES
@Q@B VT ユーザー定義キー 7 NO NO YES
@Q@C VT ユーザー定義キー 8 NO NO YES
@Q@D VT ユーザー定義キー 9 NO NO YES
@Q@E VT ユーザー定義キー 10 NO NO YES
@Q@F VT ユーザー定義キー 11 NO NO YES
@Q@G VT ユーザー定義キー 12 NO NO YES
@Q@H VT ユーザー定義キー 13 NO NO YES
@Q@I VT ユーザー定義キー 14 NO NO YES
@Q@J VT ユーザー定義キー 15 NO NO YES
@Q@K VT ユーザー定義キー 16 NO NO YES
@Q@L VT ユーザー定義キー 17 NO NO YES
@Q@M VT ユーザー定義キー 18 NO NO YES
@Q@N VT ユーザー定義キー 19 NO NO YES
@Q@0 VT ユーザー定義キー 20 NO NO YES
@Q@a VT 後退タブ NO NO YES
@Q@r VT ページ消去 NO NO YES
@Q@s VT 編集 NO NO YES

次の表は特殊文字を使用する略号の一覧です。

表 15. 特殊文字キーによる略号

略号 意味 3270 5250 VT
@@ @ YES YES YES
@$ カーソル切り替え (プレゼンテーション・マネージャー・インターフェースのみ) YES YES YES
@< バックスペース YES YES YES

次の表は BIDI キーの略号の一覧です。


表 16. BIDI キーの略号

略号 意味 3270 5250 VT
@:@s 画面強調反転 YES YES YES
@:@n BIDI 層 YES YES YES
@:@l ローマ字層 YES YES YES
@:@F フィールド強調反転 YES YES NO
@:@p プッシュ YES NO NO
@:@e プッシュ終了 YES NO NO
@:@a 自動プッシュ YES NO NO
@:@r 自動強調反転 YES NO NO
@:@d CSD YES NO NO
@:@f 最終 YES NO NO
@:@i 分離 YES NO NO
@:@m 中央 YES NO NO
@:@t 初期 YES NO NO
@:@h フィールドの形状 YES NO NO
@:@u フィールドの基本 YES NO NO
@:@b 基本 NO YES NO
@:@o クローズ NO YES NO
@:@K 列見出し NO NO YES
@:@B カーソルの方向 NO NO YES
@:@D エンコード・モード NO NO YES
@:@M VT 変更表示モード NO NO Yes (ヘブライ語のみ)

次の文字キーは表示どおりに解釈されます。


a ～ z ! ' ' < }
A ～ Z $ ( . > [
0 ～ 9 % ) / = ]
~ & * : ? |
# " + ; {

1390/1399 コード・ページ・サポート

ユニコード機能は 3270 および 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

セッション・オプション ESC はユニコード・セッションではサポートされていません。このオプションを使用してユニコード文字を ESC 文字として設定することはできません。デフォルトの ESC 文字 @ をユニコード・セッションで使用してください。詳細については、Set Session Parameters (9)を参照してください。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 3 にしてください。
データ・ストリング キー・ストロークのユニコード・ストリング。最大 255 バイト。英大文字と英小文字の ASCII 文字は、そのまま表されます。ファンクション・キーおよびシフト・ファンクション・キーは、略号によって表されます。 キーボードの略号を参照してください。
長さ ユニコード文字のユニコード・ストリングの長さ。
PS 位置 NA

戻りパラメーター

戻りコード 説明
0 キー・ストロークは送信され、状況は正常です。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 無効なパラメーターが EHLLAPI に渡されました。
4 ホスト・セッションは使用中であったため、どのキー・ストロークも送信できませんでした。
5 送信先セッションへの入力が禁止または拒否されたため、キー・ストローク全部を送信することはできませんでした。
9 システム・エラーが発生しました。

使用上の注意

キー・ストロークを PCOMM セッションに送信する前に、そのセッションがユニコード・セッションであり、現行のプラットフォームが Windows 2000 であることを確認してください。。

ストリングの長さはユニコード文字の数を示すもので、送信される ANSI 文字の数ではありません。

1137 コード・ページ・サポート

ユニコード機能は 5250 セッションでのみサポートされます。

STREOT オプションはユニコード・セッションではサポートされていません。詳細については、Set Session Parameters (9)を参照してください。

セッション・オプション ESC はユニコード・セッションではサポートされていません。このオプションを使用してユニコード文字を ESC 文字として設定することはできません。デフォルトの ESC 文字 @ をユニコード・セッションで使用してください。詳細については、Set Session Parameters (9)を参照してください。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


標準インターフェース 拡張インターフェース
関数番号 必ず 3 にしてください。
データ・ストリング キー・ストロークのユニコード・ストリング。最大 255 バイト。英大文字と英小文字の ASCII 文字は、そのまま表されます。ファンクション・キーおよびシフト・ファンクション・キーは、略号によって表されます。 キーボードの略号を参照してください。
長さ バイト単位でのユニコード・データ・ストリングの長さ。長さが 2 の倍数でない場合は、2 のエラー・コードが戻されます。
PS 位置 NA

戻りパラメーター

戻りコード 説明
0 キー・ストロークは送信され、状況は正常です。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
2 無効なパラメーターが EHLLAPI に渡されました。
4 ホスト・セッションは使用中であったため、どのキー・ストロークも送信できませんでした。
5 送信先セッションへの入力が禁止または拒否されたため、キー・ストローク全部を送信することはできませんでした。
9 システム・エラーが発生しました。

使用上の注意

キー・ストロークを PCOMM セッションに送信する前に、そのセッションがユニコード・セッションであることを確認してください。セッションが ANSI で、ユニコード・ストリングが送信されると、化けた文字が表示されます。

ストリングの長さはバイト数を示すもので、送信されるユニコード文字の数を示すものではありません。そのため、長さは 2 の倍数でなければなりません。そうでない場合は、関数によって、パラメーター・エラーが戻されます。

Set Cursor (40)


3270 5250 VT
YES YES YES

Set Cursor 関数は、ホスト表示スペース内のカーソルの位置を設定する際に使用します。 Set Cursor 関数を使用する前に、ワークステーションのアプリケーションがホストの表示スペースに接続されていることが必要です。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 40 にしてください。
データ・ストリング NA
長さ NA
PS 位置 接続したホスト表示スペース内の、配置したいカーソルの位置

戻りパラメーター


戻りコード 説明
0 カーソルは指定された位置に配置されました。
1 ユーザー・プログラムが現在ホスト・セッションに接続されていません。
4 セッションは使用中です。
7 1 より小さい、または接続されているホスト表示スペース・サイズを超えるカーソル位置が指定されました。
9 システム・エラーが発生しました。

使用上の注意

DBCS の場合のみ: 指定したカーソルが 2 バイト文字の第 2 バイトである場合、カーソルはその文字の第 1 バイトへ移動し、エラー・コードは戻されません。

1137 コード・ページ・サポート

ユニコード・セッションでの Set Cursor の使用法は、以下の点を除いて SBCS セッションと同じです。

Set Session Parameters (9)


3270 5250 VT
YES YES YES

Set Session Parameters 関数を使用して、 EHLLAPI のすべてのセッションに関して特定のデフォルト・セッション・オプションを変更することができます。EHLLAPI がロードされると、セッション・オプションのデフォルトの設定値は セッション・オプションに示す表で、下線を引いた項目のようになります。これらの値のいずれか、またはすべてを、以下で説明するように、呼び出しデータ・ストリング内に必要なオプションを入れて変更することができます。指定した設定値は次のいずれかが発生するまで有効です。

以下にセッション・オプションの影響を受ける EHLLAPI 関数の一覧表を示します。この表に記載されていない関数は、どのセッション・オプションからも影響を受けません。それぞれの関数に影響を及ぼすセッション・オプションは『参照個所』の欄の対応する項目に示されています。これらの項目は呼び出しパラメーター以降の一覧表に示されています。

関数番号   関数名   参照個所
1 Connect Presentation Space 11, 23, 24
3 Send Key 1, 2, 9, 10, 19
4 Wait 12
5 Copy Presentation Space 5, 13, 14, 15, 17, 20, 21, 22
6 Search Presentation Space 1, 2, 3, 4
8 Copy Presentation Space to String 5, 13, 14, 15, 17, 20, 21, 22
10 Query Sessions 16, 22
15 Copy String to Presentation Space 1, 2, 13, 14, 18, 20, 21, 22
18 Pause 6
30 Search Field 1, 2, 3, 4, 22
33 Copy String to Field 1, 2, 13, 14, 18, 20, 21, 22
34 Copy Field to String 5, 13, 14, 17, 20, 21, 22
51 Get Key 9, 12
90 Send File 1, 2, 7, 8
91 Receive File 1, 2, 7, 8
101 Connect Window Services 23, 24
注:
この表の項目 20 と 21 は DBCS の場合のみ

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 9 にしてください。
データ・ストリング 変更しようとするセッション・オプションの必要な値を含むストリング。データ・ストリングには、セッション・オプションに記載されているどの値でも入れることができます。値は、データ・ストリング行にコンマまたはブランクで区切って入れます。パラメーター・セットについては、それらが影響を及ぼす関数の項で説明しています。
長さ 元のデータ・ストリングの明示の長さ (STREOT オプションは使用できません)。
PS 位置 NA

セッション・オプション

以下の表にセッション・オプションを示します。デフォルト値には下線が付いています。

  1. 次の表の値は、Send Key (3)、 Search Presentation Space (6)、 Copy String to Presentation Space (15)、 Search Field (30)、 Copy String to Field (33)、 Send File (90)、および Receive File (91) の関数に対してどのようにデータ・ストリングの長さを定義するかを判別します。


    値 説明
    STRLEN すべてのストリングに対して明示の長さが渡されています。
    STREOT ストリングの長さは明示的に指定されていません。呼び出し元のデータ・ストリングは EOT 文字で終了します。

  2. 次の表の値は、EHLLAPI 関数である Send Key (3)、 Search Presentation Space (6)、 Copy String to Presentation Space (15)、 Search Field (30)、 Copy String to Field (33)、 Send File (90)、および Receive File (91) に対して呼び出し元のデータ・ストリングのテキスト終了 (EOT) 区切り文字として使用する文字を指定する際に使用します。


    値 説明
    EOT=c この値で、ストリング終了文字に EOT 文字を (STREOT モードで) 指定できます。 2 進数の 0 がデフォルト値です。等号の後をブランクにしないでください。

    有効値にするためには、1 バイトのリテラル文字ストリングとして、前にブランクを付けずに c を入力します。このステートメントで指定した EOT 文字は、STREOT オプション (セッション・オプションの 1 を参照) が有効な場合に限り、呼び出しデータ・ストリングの長さの判別に使用されます。

  3. 次の表の値は、検索関数の Search Presentation Space (6) および Search Field (30) に影響を及ぼします。


    値 説明
    SRCHALL Search Presentation Space (6) 関数と Search Field (30) 関数は、ホスト表示スペース全体またはフィールド全体を走査します。
    SRCHFROM Search Presentation Space (6) 関数と Search Field (30) 関数は、指定した PS 位置から開始 (SRCHFRWD の時) するか、または指定した PS 位置で終了 (SRCHBKWD の時) します。

  4. 次の表の値は、検索関数の Search Presentation Space (6) および Search Field (30) に影響を及ぼします。この値により、検索方向が判別されます。


    値 説明
    SRCHFRWD Search Presentation Space (6) 関数と Search Field (30) 関数は、昇順方向に実行されます。
    SRCHBKWD Search Presentation Space (6) 関数と Search Field (30) 関数は、降順方向に実行されます。検索ストリングの先頭文字が指定した範囲内にあるとき、検索の対象となります。

  5. 次の表の値は、Copy Presentation Space (5)、Copy Presentation Space to String (8)、Copy Field to String (34) の関数について、属性バイトをどのように取り扱うかを決定します。


    値 説明
    NOATTRB 不明な値をすべてブランクに変換します。
    ATTRB 元の値として ASCII に相当しないコードをすべて戻します。
    NULLATTRB フィールド属性をすべて NULL 文字に変換します。

  6. 次の表の値は、Pause (18) 関数に影響を及ぼします。


    値 説明
    FPAUSE 全期間休止。 Pause (18) 関数で指定した期間、休止します。
    IPAUSE 割り込み可能な休止。

    Start Host Notification (23) 関数の実行後、ホストのイベントが休止を終了させます。

  7. 次の表の値は、ファイル転送関数の Send File (90) および Receive File (91) が生成するメッセージを表示するかどうかを判別します。


    値 説明
    NOQUIET SEND および RECEIVE メッセージが表示されます。
    QUIET SEND および RECEIVE メッセージは表示されません。

  8. 次の表のステートメントは、ファイル転送関数の Send File (90) および Receive File (91) の実行中にパーソナル・コミュニケーションズ EHLLAPI がどれくらい待機してから Cancel を自動的に発行するかを判別します。有効値にするために、c をアラビア数字の 0～9 または英文字の J～N にして、前にブランクを入れないでください。


    値 説明
    TIMEOUT=0 約 20 秒の遅延の後に Cancel が自動的に発行されます。
    TIMEOUT=c 指定した遅延の後に Cancel が自動的に発行されます。下の表にある 1 文字の標識は、Cancel を発行する前に、30 秒サイクルを何回受け入れる必要があるかを パーソナル・コミュニケーションズ に通知します。

    文字
    値 (分)

    1
    0.5

    2
    1.0

    3
    1.5

    4
    2.0

    5
    2.5

    6
    3.0

    7
    3.5

    8
    4.0

    9
    4.5

    J
    5.0

    K
    5.5

    L
    6.0

    M
    6.5

    N
    7.0

  9. 次の表のステートメントは、キー・ストローク略号に対するエスケープ文字を定義するために使用します。このセッション・オプションは、Send Key (3) 関数と Get Key (51) 関数に影響を及ぼします。有効値にするためには、1 バイトのリテラル文字ストリングとして、前にブランクを付けずに c を入力します。


    値 説明
    ESC=c この値により、キー・ストローク略号に対するエスケープ文字を指定できます (@ がデフォルト値)。等号の後をブランクにしないでください。ブランクはエスケープ文字に使用できません。

  10. 次の表の値は、Send Key (3) 関数を使用して送信されたストリングを EHLLAPI が先に自動的にリセットするかどうかを判別します。


    値 説明
    AUTORESET EHLLAPI は、リセット付きの Send Key (3) 関数を使用して送信されたキーの全ストリングに接頭部を付けることにより、すべての使用禁止条件のリセットを試行します。
    NORESET AUTORESET を行いません。

  11. 次の表の値は、 Connect Presentation Space (1) コマンド関数に影響を及ぼします。
    値 説明
    CONLOG ワークステーション・セッションとホスト・セッションの間の論理接続を確立します。接続中は、要求された表示スペースへジャンプしません。
    CONPHYS ワークステーション・セッションとホスト・セッションの間の物理接続を確立します。接続中に、要求された表示スペースへジャンプします。

  12. 次の表の値は、 Wait (4) 関数と Get Key (51) 関数に影響を及ぼします。それぞれの値については、2 つの異なる影響があり、それぞれの関数に対応しています。


    値 説明
    TWAIT Wait (4) 関数は、XCLOCK (X []) または XSYSTEM でタイムアウトになるまで最大 1 分間待機します。

    Get Key (51) 関数は、EHLLAPI アプリケーション・プログラムがキーを代行受信してから、そのアプリケーションに制御を戻します (このキーは、通常のキーまたは Start Keystroke Intercept (50) 関数で指定されたオプションに基づく AID キーです)。

    LWAIT Wait (4) 関数は、 XCLOCK (X [])/XSYSTEM がクリアされるまで待機します。ホストが使用可能になるまでユーザーのアプリケーションに制御が戻らないため、このオプションはお勧めできません。

    Get Key (51) 関数は、EHLLAPI アプリケーション・プログラムがキーを代行受信してから、そのアプリケーションに制御を戻します (このキーは、通常のキーまたは Start Keystroke Intercept (50) 関数で指定されたオプションに基づく AID キーです)。

    NWAIT Wait (4) 関数は、状況をチェックし、即座に状況を戻します (待機なし)。

    Get Key (51) 関数は、 Start Keystroke Intercept (50) 関数で指定されたオプションに一致したオプションがキューにないと、4 番目のパラメーターに戻りコード 25 (キー・ストローク使用不可) を戻します。

    注:
    NWAIT を使用するようお勧めします。
  13. 次の表の値は、Copy Presentation Space (5)、 Copy Presentation Space to String (8)、 Copy String to Presentation Space (15)、Copy String to Field (33) および Copy Field to String (34) に影響を及ぼします。拡張属性バイト (EAB) には、拡張文字属性および拡張フィールド属性が含まれます。


    値 説明
    NOEAB データのみを渡します (EAB なし)。
    EAB 拡張属性バイトを指定して表示スペース・データを渡します。画面に表示されるそれぞれの文字については、2 バイトのデータが渡されます。このため、表示スペースの 2 倍のサイズのバッファーを事前割り振りしておくことが必要です。例えば、2 x 1920 = 3840 (24 行 80 桁の表示スペース用)。

    文字ストリングの拡張属性は、フィールド内の個々の文字の属性としてではなく、フィールド・バイトの属性として報告される場合があります。このような場合、画面上の個々の文字または文字セットに下線が付けられるかどうかを知るには、フィールド属性バイト (画面に表示されるフィールドの前にあるバイト) の位置を指定して CopyPStoString を実行し、そのフィールド内の全文字に適用される EAB 情報を得てください。

    注:
    EHLLAPI Copy PS to String を使用すると、オペレーターには見えないようにすべきテキストがコピーされます。隠しデータがあるかどうかを判別するには、EHLLAPI Set Session Parameters 関数を使用して、NODISPLAY オプションを設定してください。これにより、EHLLAPI は非表示フィールドを NULL として戻します。データを隠すための一般的な別の手順は、前景と背景の色を同一色 (例えば、黒色) に設定して、テキストは表示されるが人間のオペレーターには見えないようにすることです。アプリケーションにこれを検出させる唯一の方法は、 EAB と XLATE のセッション・パラメーターを使用して PS をコピーすることです。各バイト位置の前景/背景の色が戻され、見えない文字を判別することができます。
  14. 次の表の値は、Copy Presentation Space (5)、 Copy Presentation Space to String (8)、 Copy String to Presentation Space (15)、Copy String to Field (33) および Copy Field to String (34) に影響を及ぼします。


    値 説明
    NOXLATE EAB は変換されません。
    XLATE EAB は PC のカラー・グラフィックス・アダプター (CGA) 形式に変換されます。

  15. 次の表の値は、NOATTRB と NOEAB が指定されている場合、Copy Presentation Space (5) および Copy Presentation Space to String (8) に影響を及ぼします。


    値 説明
    BLANK 不明な値をすべて X'20' に変換します。
    NOBLANK 不明な値をすべて X'00' に変換します。

    デフォルト値は BLANK です。デフォルト値を NOBLANK に変更したい場合は、パーソナル・コミュニケーションズのユーザー・クラス・アプリケーション・データのディレクトリーに配置されている PCSWIN.INI ファイルに、以下のステートメントを追加してください。 

    [API]
NullToBlank=NO
  16. 次の表の値は、Query Sessions (10) により戻される表示スペースのサイズに影響を及ぼします。
    値 説明
    CFGSIZE 接続されている表示スペースの構成サイズを戻します。このオプションは、ホストによる構成サイズの一時変更を無視します。
    NOCFGSIZE 接続されている表示スペースの現在のサイズを戻します。

  17. 次の表の値は、Copy Presentation Space (5)、Copy Presentation Space to String (8)、および Copy Field to String (34) に影響を及ぼします。
    値 説明
    DISPLAY 表示スペース内の非表示フィールドを、コピー先のバッファー域にコピーします。現行のアプリケーションは、通常通りに機能します。
    NODISPLAY 表示スペース内の非表示フィールドを、表示フィールドと同じ方法でコピー先のバッファー域にコピーしません。非表示フィールドは、コピー先のバッファーに NULL 文字のストリングとしてコピーされます。これにより、アプリケーションでは、パスワードなどの機密情報を表示せずに、コピーしたバッファーをプレゼンテーション・ウィンドウに表示することができます。

  18. 次の表の値は、Copy String to Presentation Space (15) および Copy String to Field (33) に影響を及ぼします。
    値 説明
    NOPUTEAB Copy String to Presentation Space または Copy String to Field のデータ・ストリングに EAB (DBCS の場合は EAD) を含めません。
    PUTEAB Copy String to Presentation Space または Copy String to Field のデータ・ストリングに EAB を含めます。

    このオプションは、コミュニケーション・マネージャー/2 と互換性を持たせるためのものです。コミュニケーション・マネージャー/2 では、Set Session Parameters の EAB (または EAD) が有効なときは、Copy String to Presentation Space または Copy String to Field で指定するデータ・ストリングに、EAB (または EAD) が文字データと共に含まれていなければなりません。一方、従来のパーソナル・コミュニケーションズでは、EAB (または EAD) が有効であっても、これらの関数に指定するデータ・ストリングに含まれるのは文字データのみでした。しかし、パーソナル・コミュニケーションズでは、PUTEAB を設定して、データ・ストリングの中に EAB (または EAD) を含めることにより、コミュニケーション・マネージャー/2との互換性を持つことができます。

  19. 次の表の値は、Send Key (3) 関数に影響を及ぼします。キーボードがブロックまたは使用されている場合、キー・ストロークは処理されません。 4 分のタイムアウトが発生するまで、関数がキー・ストロークの再送を試行するか、あるいは、キーボードがブロックまたは使用されていることが確認されて即座に関数が戻るかどうかを、このオプションにより決定します。


    値 説明
    RETRY キー・ストロークが送信されるか、4 分のタイムアウトが発生するまでキー・ストロークの送信を試行し続けます。
    NORETRY キーボードがブロックまたは使用されていることが確認されたら、関数は即座に戻ります。

  20. DBCS の場合のみ: 次の表は、 Copy Presentation Space (5)、 Copy Presentation Space to String (8)、 Copy String to Presentation Space (15)、 Copy String to Field (33)、および Copy Field to String (34) に影響を及ぼします。


    値 説明
    NOEAD DBCS に関する属性文字を渡しません。
    EAD 表示スペースのデータと 2 バイト文字セット (DBCS) に関する 2 つの属性文字を渡します。 (ユーザーはデータの他にそれぞれの文字ごとに 2 バイトを受け取ります。したがって、表示スペース用に 2 倍のサイズのバッファーを事前に割り当てる必要があります。)

  21. DBCS の場合のみ: 次の表は、 Copy Presentation Space (5)、 Copy Presentation Space to String (8)、 Copy String to Presentation Space (15)、 Copy String to Field (33)、および Copy Field to String (34) に影響を及ぼします。


    値 説明
    NOSO 表示スペースから、シフトイン (SI) およびシフトアウト (SO) の各制御文字を除いたデータを渡します。
    SO X'0E' に変換された SI 制御文字と X'0F' に変換された SO 制御文字を含む表示スペース・データを渡します。バッファーに割り当てられるサイズは、そこに保管するデータの長さによって決まります。
    SPACESO X'20' (ブランク) に変換された SI 制御文字と SO 制御文字を含む表示スペース・データを渡します。バッファーに割り当てられるサイズは、そこに保管するデータの長さによって決まります。

  22. 次の表の値は、Copy Presentation Space (5)、Copy Presentation Space to String (8)、Copy String to Presentation Space (15)、Copy String to Field (33)、Copy Field to String (34) Search Field (30) および Query Sessions (10) に影響を及ぼします。
    値 説明
    EXTEND_PS 5250 エミュレーションは、24 行 80 桁の表示スペースをサポートします。コミュニケーション・マネージャー 5250 エミュレーションが 25 番目の行を表示するインスタンスもあります。このようなことが起こるのは、ホストからのエラー・メッセージが表示される場合、またはオペレーターが SysReq キーを選択する場合です。パーソナル・コミュニケーションズは、25 行目の情報を 24 行目に表示しますが、EHLLAPI は、通常は実際の 24 行を参照します。 EXTEND_PS オプションを指定すると、EHLLAPI アプリケーションでコミュニケーション・マネージャー EHLLAPI と同じインターフェースを使用することができ、このような状況が発生した時に有効な表示スペースが拡張されます。
    NOEXTEND_PS 上記の状態が発生した場合に表示スペースを拡張しません。これはデフォルト値です。
  23. 次の表の値は、Connect Presentation Space (1) と Connect Window Services (101) 関数に影響を及ぼします。これらのオプションは、アプリケーションで、それが接続されている表示スペースを他の表示スペースと共用できるか、また共用することになるかを指定します。各 Set Session Parameter 呼び出しについて、次の値のうち 1 つだけを指定することができます。


    値 説明
    SUPER_WRITE アプリケーションは、共用が可能で書き込みアクセス許可を有する他のアプリケーションに同時に同じ表示スペースに接続することを許可します。この関数を呼び出したアプリケーションでは、監視タイプの関数が実行されますが、表示スペースを共用する他のアプリケーションに対してエラーは生成されません。
    WRITE_SUPER アプリケーションは、書き込みアクセスを要求し、監視アプリケーションだけにその表示スペースへ同時に接続することを許可します。これはデフォルト値です。
    WRITE_WRITE アプリケーションは、書き込みアクセスを要求し、その動作が予測可能なパートナーまたは他のアプリケーションに表示スペースを共用することを許可します。
    WRITE_READ アプリケーションは、書き込みアクセスを要求し、読み取り専用関数を実行する他のアプリケーションに表示スペースを共用することを許可します。また、表示スペースのコピーおよび他の読み取り専用操作を通常通り実行することもできます。
    WRITE_NONE アプリケーションは、表示スペースを排他使用します。監視アプリケーションも含めて、他のアプリケーションは、表示スペースを共用できません。また、表示スペースのコピーおよび他の読み取り専用操作を通常通り実行することもできます。
    READ_WRITE アプリケーションは、表示スペースをモニターするための読み取りアクセスのみを要求し、読み取りまたは書き込み (あるいはその両方の) 関数を実行する他のアプリケーションに表示スペースを共用することを許可します。また、表示スペースのコピーおよび他の読み取り専用操作を通常通り実行することもできます。

  24. 次の表の値により、アプリケーションは、表示スペースの共用の要求を、パートナー・アプリケーション (一緒に動作するよう開発されたアプリケーション) との間での共用に制限することができます。


    値 説明
    NOKEY この値を指定すると、アプリケーションは、KEY パラメーターを指定していない既存のアプリケーションとの互換性を持つようになります。
    KEY$nnnnnnnn サポートする表示スペースの共用アクセスを制限するために、キーワードを使用します。キーワードは、正確に 8 バイトの長さでなければなりません。

戻りパラメーター

この関数はデータ・ストリング長および戻りコードを戻します。

データ・ストリング長:
設定された正しいセッション・パラメーターの数。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 セッション・パラメーターが設定されました。
2 1 つ以上のパラメーターが無効でした。
9 システム・エラーが発生しました。

1390/1399 および 1137 コード・ページ・サポート

コード・ページ 1390/1399 ユニコード機能は 3270 および 5250 セッションでのみ選択可能です。コード・ページ 1137 ユニコード機能は 5250 セッションでのみ選択可能です。

ユニコード・セッションの 1390/1399 および 1137 コード・ページ・サポートについて、以下のセッション・オプションの違いに注意してください。

Start Close Intercept (41)


3270 5250 VT
YES YES YES

Start Close Intercept 関数を使用して、アプリケーションは、ユーザーがエミュレーター・セッション・ウィンドウから終了オプションを選択したときに生成される終了要求を代行受信できます。この関数は Stop Close Intercept (43) 関数が要求されるまで、クローズ要求を代行受信してそれを破棄します。

この関数を使用した後、アプリケーション・プログラムは Query Close Intercept (42) 関数を使用して、いつ終了要求が出されたかを確認することができます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


バイト位置 定義
  標準インターフェース 拡張インターフェース
関数番号 必ず 41 にしてください。
データ・ストリング 次の表を参照してください。
長さ 5 または 6 にしてください。 必ず 12 にしてください。
PS 位置 NA

データ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 4 予約済み。
4 ～ 5
この位置にあるデータは EHLLAPI で無視されます。ただし、移行プログラムでこの位置にデータを指定していても、エラーは発生しません。このデータはアプリケーションの移行時に互換性を保つために設けられています。
6 5 非同期メッセージ・モードを要求する場合は、M を指定します (Windows のみ)。
6 ～ 8 予約済み。
2 ～ 3 9 ～ 12 バイト位置 5 (16 ビットの場合は 6) に M を指定した場合、メッセージを受け取るウィンドウのウィンドウ・ハンドルを設定してください。メッセージは、RegisterWindowMessage (PCSHLL) の戻り値 (0 以外) です。

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
非同期メッセージ・モードをバイト位置 5 (標準インターフェースの場合は 6) に指定しないで、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 8 予約済み。
9 ～ 12 EHLLAPIによってイベント・オブジェクト・アドレスが戻される 4 バイト値。アプリケーションは、このイベント・オブジェクトを待ちます。(32 ビットのみ。)

データ・ストリング:
M (非同期メッセージ・モード) をバイト位置 5 (標準インターフェースの場合は 6) に指定して、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 8 予約済み
2 ～ 3 9 ～ 10 非同期メッセージ・モードのタスク ID
注:
ユーザーが終了オプションを選択すると、アプリケーション・ウィンドウはメッセージを受け取ります。メッセージは、RegisterWindowMessage(PCSHLL) の戻り値です。wParam パラメーターには、この関数呼び出しによって戻されたタスク ID が入ります。 lParam パラメーターの HIWORD には戻りコード 26 (代行受信の終了) が入り、lParam パラメーターの LOWORD には関数番号 41 が入ります。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Start Close Intercept 関数は正常終了しました。
1 ホストの無効な表示スペースが指定されました。
2 パラメーター・エラーが生じました。
9 システム・エラーが発生しました。
10 エミュレーション・プログラムはこの関数をサポートしていません。

使用上の注意

  1. 開始要求関数が戻される場合は、戻されるイベント・オブジェクトまたはセマフォーは非通知状態になります。イベント・オブジェクトは、終了要求が出されるたびに通知状態になります。複数の終了要求イベントに対する通知を受信するためには、SetEvent または Query Close Intercept (42) 関数を使用して、毎回イベント・オブジェクトを通知状態にすることが必要です。
  2. この関数を使用した後、アプリケーション・プログラムは Query Close Intercept (42) 関数を使用して、いつ終了要求が出されたかを確認することができます。アプリケーションは、そのイベントが発生したことを確認するために戻されるイベント・オブジェクトを待つこともできます。
  3. これは排他呼び出しではありません。同じ短縮セッション ID に対して、複数のアプリケーションがこの関数を要求することができます。
  4. アプリケーションがセッションに対する終了要求を代行受信しない場合、その後ユーザーがエミュレーター操作ダイアログから選択した終了要求がそのセッションに対する正常停止の要求となります。

Start Communication Notification (80)


3270 5250 VT
YES YES YES

Start Communication Notification 関数はプロセスを開始します。このプロセスによって、ユーザーの EHLLAPI アプリケーションは、指定されたセッションがホストに接続されているかどうかを判別できます。

この関数を使用した後、アプリケーションは、Query Communication Event (81) を使用して、セッションが接続されているか、または切断されているかを判別できます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター



拡張インターフェース
関数番号 必ず 80 にしてください。
データ・ストリング 事前に割り振られた構造。次の表を参照してください。
長さ 16
PS 位置 NA

呼び出しデータ構造には、以下の要素が含まれます。

バイト位置 定義
1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 4 予約済み
5 次のいずれかの値:
  • 文字 C はセッションがホストから切断、またはホストに接続されたときの通知を要求します。
  • 文字 A は、非同期モードの通知を要求します。A を指定した場合は、バイト位置 9 ～ 12 にイベント・オブジェクト (Windows) のアドレスが戻されます。文字 C を、位置 13 に指定する必要があります。
  • 文字 M は、非同期メッセージ・モードの通知を要求します。 M を指定する場合、イベント選択文字 C をバイト位置 13 に指定する必要があります。
6 ～ 8 予約済み
9 ～ 12 バイト位置 5 に M を指定した場合、メッセージを受け取るウィンドウのウィンドウ・ハンドルを指定してください。メッセージは、RegisterWindowMessage (PCSHLL) の戻り値 (0 以外) です。
13 バイト位置 5 が A または M の場合、このバイトは文字 C を含む必要があります。
14 ～ 16 予約済み

データ・ストリング

A (非同期モード) を呼び出しデータ構造のバイト位置 5 に指定して、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
1 1 文字の表示スペース短縮名 (PSID)
2 ～ 8 予約済み
9 ～ 12 EHLLAPI によってイベント・オブジェクト・ハンドルが戻される、4 バイトの 2 進値。アプリケーションは、このイベント・オブジェクトを待ちます。

M (非同期メッセージ・モード) を呼び出しデータ構造のバイト位置 5 に指定して、この関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
1 1 文字の表示スペース短縮名 (PSID)
2 ～ 8 予約済み
9 ～ 10 非同期メッセージ・モードのタスク ID

セッションがアプリケーション・ウィンドウを接続または切断したとき、メッセージを受信します。このメッセージは、RegisterWindowMessage (PCSHLL) の戻り値です。 wParam には、関数呼び出しによって戻されたタスク ID が入ります。セッションがホストに接続された場合、lParam の HIWORD には 21 が入り、セッションがホストから切断された場合、lParam の HIWORD には 22 が入ります。lParam の LOWORD には関数番号 80 が入ります。

戻りパラメーター


戻りコード 定義
0 関数は正常終了しました。
1 誤った PSID が指定されました。
2 指定されたパラメーターに誤りがありました。
9 システム・エラーが発生しました。

使用上の注意

  1. 1 つのアプリケーション・プログラムが複数のホスト・セッションでこの関数を発行することができます。セッションの通信状況を判別するために、 Query Communication Event (81) 関数を使用することができます。
  2. アプリケーションが非同期オプションを選択した場合、そのアプリケーションは Windows SDK 呼び出し WaitForSingleObject を使用して、そのセッションの通信状況が変化するのを待つことができます。
  3. このイベント・オブジェクトは、最初は非通知状態にあります。イベントが起こるたびに、イベント・オブジェクトは通知されます。複数のイベントに対する通知を受信するためには、アプリケーションは、 Windows SDK 呼び出し ResetEvent、または、関数 81 Query Communications Event を使用して、通知されるたびにイベント・オブジェクトを非通知状態にする必要があります。
  4. 同じアプリケーションからの同じオプションを指定したこの関数への複数の呼び出しは、無視されます。
  5. この関数は 1 つのアプリケーションに対して排他的ではありません。同じセッション ID に対して、複数のアプリケーションがこの関数を要求することができます。

Start Host Notification (23)


3270 5250 VT
YES YES YES

Start Host Notification 関数は、指定されたホスト表示スペースまたは OIA が更新されたかどうかを EHLLAPI アプリケーション・プログラムが判別するための処理を開始します。

この関数を使用した後、アプリケーション・プログラムは Query Host Update (24) 関数を使用して、いつホスト・イベントが発生したかを確認することができます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 23 にしてください。
データ・ストリング 事前に割り振られたストリング。次の表を参照してください。
長さ 6 または 7 が暗黙指定されます。 16
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 次のいずれかの値:
  • 表示スペースの 1 文字の短縮名 (PSID)
  • ホスト接続のホスト表示スペースに対する要求を示すブランクまたは NULL 文字
2 ～ 4 予約済み。
2 5 次のいずれかの値:
  • B -- ホスト表示スペースと OIA の両方の更新通知を要求します。
  • O -- OIA の更新通知のみを要求します。
  • P -- ホスト表示スペースの更新通知のみを要求します。
  • A -- 非同期モードの通知を要求します。A を指定した場合は、バイト位置 9 ～ 12 にイベント・オブジェクトのアドレスが戻されます。イベント選択文字 B、O、P はバイト位置 13 に指定する必要があります。
  • M -- 非同期メッセージ・モードの通知を要求します。

    M を指定する場合、イベント選択文字 B、O、P のいずれかをバイト位置 13 (16 ビットの場合は 7) に指定します。

  • E は、プリンター・セッション中の完了通知を要求する文字です。
6 ～ 8 予約済み。
3 ～ 4 9 ～ 12 バイト位置 5 (16 ビットの場合は 2) に M を指定した場合、メッセージを受け取るウィンドウのウィンドウ・ハンドルを指定してください。メッセージは、RegisterWindowMessage (PCSHLL) の戻り値 (0 以外) です。
7 13 バイト位置 5 (16 ビットの場合は 2) に A または M を指定した場合、値は次のいずれかです。
  • B -- ホスト表示スペースと OIA の両方の更新通知を要求します。
  • O -- OIA の更新通知のみを要求します。
  • P -- ホスト・プレゼンテーションの更新通知のみを要求します。
14 ～ 16 予約済み。

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
A (非同期モードの通知) をバイト位置 5 に指定し、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 8 予約済み。
9 ～ 12 EHLLAPI によってイベント・オブジェクト・アドレスが戻される 4 バイト値。アプリケーションは、このイベント・オブジェクトを待ちます (32 ビットのみ)。

データ・ストリング:
M (非同期メッセージ・モード) をバイト位置 5 (標準インターフェースの場合は 2) に指定して、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 8 予約済み
3 ～ 4 9 ～ 10 非同期メッセージ・モードのタスク ID
注:
OIA または表示スペースを更新すると、アプリケーション・ウィンドウはメッセージを受け取ります。メッセージは、RegisterWindowMessage(PCSHLL) の戻り値です。wParam パラメーターには、関数呼び出しによって戻されたタスク ID が入ります。 lParam の HIWORD には戻りコード 21 (OIA の更新)、22 (ホスト表示スペースの更新)、23 (OIA とホスト表示スペースの両方の更新) が入り、lParam パラメーターの LOWORD には関数番号 23 が入ります。

戻りコード:
以下のコードが定義されています。

戻りコード 定義
0 Start Host Notification 関数は正常終了しました。
1 ホストの無効な表示スペースが指定されました。
2 指定されたパラメーターに誤りがありました。
9 システム・エラーが発生しました。

使用上の注意

  1. 1 つのアプリケーション・プログラムが複数のホスト・セッションでこの関数を発行することができます。 Pause (18) 関数により、1 つ以上のホスト・セッション (PS、OIA、またはその両方) が変更された時点でアプリケーションに通知することができます。PS、OIA、またはその両方が変更されたかどうかを判別するために Query Host Update (24) 関数を使用することができます。
  2. アプリケーションで非同期オプションを選択した場合、アプリケーションは、そのイベントが発生した時期を判別するために戻されるイベント・オブジェクトまたはセマフォーを待つこともできます。
  3. イベント・オブジェクトまたはセマフォーは、最初は非送信状態であり、該当のイベントが発生するたびに送信されます。複数のイベントに対する通知を受信するためには、アプリケーションは、 ResetEvent または Query Host Update (24) 関数を使用して、通知されるたびにイベント・オブジェクトを非通知状態にする必要があります。
  4. アプリケーションは、同じオプションで Start Host Notification を複数回要求することはできません。
  5. これは排他呼び出しではありません。同じ短縮セッション ID に対して、複数のアプリケーションがこの関数を要求することができます。

Start Keystroke Intercept (50)


3270 5250 VT
YES YES YES

Start Keystroke Intercept 関数により、ワークステーションのアプリケーションは、端末オペレーターがセッションに送信したキー・ストロークをフィルターにかけることができます。この関数を呼び出した後、キー・ストローク・キューがオーバーフローするまで、あるいは、Stop Keystroke Intercept (53) 関数または Reset System (21) 関数が呼び出されるまで、キー・ストロークは代行受信されて保管されます。代行受信したキー・ストロークは以下のように処理することができます。

前提呼び出し

この関数には前提呼び出しはありません。

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 50 にしてください。
データ・ストリング 次の表を参照してください。
長さ キー・ストローク・バッファー・サイズ。 EHLLAPI は、このバッファーに最低 32 バイトを割り振ります。
PS 位置 NA

呼び出しデータ・ストリングには次のものが入っています。

バイト位置 定義
標準 拡張  
1 1 次のいずれかの値:
  • 特定のホスト表示スペースの短縮名 (PSID)
  • ホスト接続のホスト表示スペースに対する要求を示すブランクまたは NULL 文字
2 ～ 4 予約済み。
2 5 オプション・コード文字
  • D -- AID キー・ストロークのみ。
  • L -- すべてのキー・ストローク。
  • M -- 非同期メッセージ・モードの通知要求 (Windows のみ)。

    M を指定する場合、コード文字 D または L をバイト位置 13 (16 ビットの場合は 7) に指定します。

6 ～ 8 予約済み。
3 ～ 4 9 ～ 12 バイト位置 5 (16 ビットの場合は 2) に M を指定した場合、メッセージを受け取るウィンドウのウィンドウ・ハンドルを指定してください。メッセージは、RegisterWindowMessage (PCSHLL) の戻り値 (0 以外) です。
7 13 バイト位置 5 (16 ビットの場合は 2) に M を指定した場合、値は次のいずれかです。
  • D -- AID キー・ストロークのみ。
  • L -- すべてのキー・ストローク。
14 ～ 16 予約済み。

データ・ストリング:
M (非同期メッセージ・モード) をバイト位置 5 (標準インターフェースの場合は 2) に指定して、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 8 予約済み
3 ～ 4 9 ～ 10 非同期メッセージ・モードのタスク ID
注:
ユーザーがセッションへキー・ストロークを送信すると、アプリケーション・ウィンドウはメッセージを受け取ります。メッセージは、RegisterWindowMessge (PCSHLL) の戻り値です。wParam パラメーターには、関数呼び出しによって戻されたタスク ID が入ります。 lParam パラメーターの HIWORD には戻りコード 0 (関数の正常終了) が入り、LOWORD には関数番号 50 が入ります。

戻りパラメーター


戻りコード 説明
0 Start Keystroke Intercept 関数は正常終了しました。
1 無効な表示スペースが指定されました。
2 無効なオプションが指定されました。
4 該当する表示スペースが使用中のため、関数は実行できません。
9 システム・エラーが発生しました。 Release が使用中です。

使用上の注意

  1. Get Key (51) 関数に対して戻りコードが 31 になる場合は、以下のどちらかを行ってください。

    代行受信されたキー・ストロークは、バッファー中の 3 バイトを使用します。次の代行受信されたキー・ストロークは、隣接する 3 バイトに置かれます。 Get Key (51) 関数がキー・ストローク (先入れ、先出し、FIFO) を取り出す場合は、そのキー・ストロークが使用していた 3 バイトを他のキー・ストロークで使用できるようになります。バッファーのサイズを増やすか、バッファーからキー・ストロークを取り出す頻度を増やすことによって、バッファーのオーバーフローを避けることができます。

    PC/3270 において、戻りコード 31 を除去する他の方法は、再開モードで PC/3270 エミュレーターを操作することです。

  2. オプション・コード D が指定されている場合、EHLLAPI は非 AID キーを、本来予定されている表示スペースへ書き込み、AID キーのみをアプリケーションに戻します。
  3. Stop Keystroke Intercept (53) 関数を呼び出してから、EHLLAPI アプリケーションを終了してください。この関数を呼び出さない場合は、キー・ストロークの代行受信機能が引き続き使用可能となり、予測できない結果が発生します。

Start Playing Macro (110)


3270 5250 VT
YES YES YES

Start Playing Macro 関数を使用してマクロを呼び出します。マクロは接続しているセッションで実行されます。

注:
このマクロは、パーソナル・コミュニケーションズのユーザー・クラス・アプリケーション・データのディレクトリーに存在する必要があります。さらに、このマクロ名の関数呼び出しには拡張子を指定してはなりません。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース
関数番号 必ず 110 にしてください。
データ・ストリング 次の表を参照してください。
長さ マクロ名の長さに 3 を加えたもの
PS 位置 NA

バイト位置 定義
標準 拡張  
1 ～ 2 予約済み
3 ～ n NULL で終了するマクロ名

戻りパラメーター


戻りコード 説明
0 Start Playing Macro 関数は正常終了しました。
1 プログラムが現在ホスト・セッションに接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。

Stop Close Intercept (43)


3270 5250 VT
YES YES YES

Stop Close Intercept 関数によりアプリケーションは Start Close Intercept (41) 関数をオフにすることができます。アプリケーションにより Stop Close Intercept 関数が発行されると、その後の終了要求は通常停止となって論理端末セッションへ送信されます。

前提呼び出し

Start Close Intercept (41)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 43 にしてください。
データ・ストリング ホスト表示スペースの 1 文字の短縮セッション ID。
長さ 1 必ず 4 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター


戻りコード 説明
0 Stop Close Intercept 関数は正常終了しました。
1 ホストの無効な表示スペースが指定されました。
2 パラメーター指定でエラーが発生しました。
8 Start Close Intercept (41) 関数が事前に発行されていませんでした。
9 システム・エラーが発生しました。
12 セッションが停止しました。

Stop Communication Notification (82)


3270 5250 VT
YES YES YES

Stop Communication Notification は、指定されたセッションでなんらかの通信イベントが発生したかどうかを判別する Query Communication Event (81) 関数を使用停止にします。

前提呼び出し

Start Communication Notification (80)

呼び出しパラメーター



拡張インターフェース
関数番号 必ず 82 にしてください。
データ・ストリング 1 文字のホスト表示スペースの短縮名、またはホスト接続されている表示スペースへの更新要求を表すブランクあるいは NULL。
長さ 4 が暗黙指定されます。
PS 位置 NA

呼び出しデータ構造には、以下の要素が含まれます。

バイト位置 定義
1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター


戻りコード 定義
0 関数は正常終了しました。
1 誤った PSID が指定されました。
8 この PSID に対して、先に Start Communication Notification (80) 関数が呼び出されていません。
9 システム・エラーが発生しました。

Stop Host Notification (25)


3270 5250 VT
YES YES YES

Stop Host Notification 関数は、ホスト表示スペースまたは OIA が更新されたかどうかを確認する Query Host Update (24) 関数を使用不可にします。

この関数は、ホストのイベントが Pause (18) 関数に影響を及ぼすことも防ぎます。

前提呼び出し

Start Host Notification (23)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 121 にしてください。
データ・ストリング 以下の注を参照してください。
長さ 1 が暗黙指定されます。 必ず 4 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
注:
該当する表示スペースの 1 文字の短縮 ID、またはホストで接続する表示スペースへの要求を表すブランクあるいは NULL。

戻りパラメーター


戻りコード 定義
0 Stop Host Notification 関数は正常終了しました。
1 ホストの無効な表示スペースが指定されました。
8 Start Host Notification (23) 関数が事前に発行されていませんでした。
9 システム・エラーが発生しました。

Stop Keystroke Intercept (53)


3270 5250 VT
YES YES YES

Stop Keystroke Intercept 関数は、アプリケーション・プログラムのキー・ストローク代行受信を終了します。

前提呼び出し

Start Keystroke Intercept (50)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 53 にしてください。
データ・ストリング 該当する表示スペースの短縮名 (PSID)
長さ 1 が暗黙指定されます。 必ず 4 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み

戻りパラメーター


戻りコード 説明
0 Stop Keystroke Intercept 関数は正常終了しました。
1 無効な表示スペースが指定されました。
8 この表示スペースに対して、先に Start Keystroke Intercept (50) 関数が呼び出されていません。
9 システム・エラーが発生しました。

Wait (4)


3270 5250 VT
YES YES YES

Wait 関数は、ホストで接続する表示スペースの状況をチェックします。セッションがホストの応答 (XCLOCK (X []) または XSYSTEM で示される) を待機している場合、Wait 関数は、待機状態が解除されたかどうかを確認するため、EHLLAPI を最大 1 分間待機させます。

前提呼び出し

Connect Presentation Space (1)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 4 にしてください。
データ・ストリング NA
長さ NA
PS 位置 NA

戻りパラメーター


戻りコード 定義
0 キーボードはアンロックされており、入力できます。
1 アプリケーション・プログラムが正しいセッションに接続されていません。
4 XCLOCK (X []) または XSYSTEM の間にタイムアウトになりました。
5 キーボードがロックされています。
9 システム・エラーが発生しました。

使用上の注意

  1. Wait 関数は、Send Key (3) などの関数によるホスト要求を完了するために必要な時間を提供します。

    Set Session Parameters (9) 関数を使用して、TWAIT、LWAIT、または NWAIT の各オプションを要求することができます。12 を参照してください。

  2. この関数を使用して、ホストの OIA が使用禁止かどうかを調べることができます。
  3. ホストがキーボードをアンロックすると、 Wait 関数が実行されます。したがって、戻りコード 0 は、トランザクションが完了したことを必ずしも意味しません。トランザクションの完了を確認するには、Search Field (30) 関数または Search Presentation Space (6) 関数を、Wait 関数と組み合わせて使用し、該当するキーワード・プロンプトを探してください。

Window Status (104)


3270 5250 VT
YES YES YES

Window Status 関数を使用して、アプリケーションはウィンドウの表示スペース・サイズ、位置、表示状態を照会したり変更することができます。

前提呼び出し

Connect Window Services (101)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 104 にしてください。
データ・ストリング 次の表を参照してください。
長さ 16 または 20 にしてください。 24 または 28 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張  
1 1 表示スペースの 1 文字の短縮名 (PSID)
2 ～ 4 予約済み
2 5 要求オプションの値。次のうちの 1 つを選択してください。
  • 状況設定には X'01'

    注:
    セッションが複合 OLE 文書に組み込まれている場合は、この関数のセット形式 (バイト 5 = X'01') は常に 0 を戻しますが、何も行われません。
  • 状況照会には X'02'
  • 拡張状況照会には X'03'

6 予約済み

要求オプションの値が X'01' (状況設定) の場合:

バイト位置 定義
標準 拡張  
3 ～ 4 7 ～ 8 要求オプションが 1 (状況設定) の場合には、状況設定ビットを含む 16 ビット/32 ビットのワード。要求オプションが状況設定の場合、有効な戻り値は以下のコードです。

X'0001'
ウィンドウ・サイズを変更します。 (最小化、最大化、復元、移動は無効)

X'0002'
ウィンドウを移動します。 (最小化、最大化、サイズ変更、復元は無効)

X'0004'
ZORDER ウィンドウの置き換え。

X'0008'
ウィンドウを可視状態に設定します。

X'0010'
ウィンドウを不可視状態に設定します。

X'0080'
ウィンドウを活動状態にします。 (ZORDER が指定されていない場合には、ウィンドウ・フォーカスを設定し、前面に配置します。この場合、ZORDER 配置が使用されます。)

X'0100'
ウィンドウを非活動状態にします。 (ZORDER も共に指定されていない場合には、ウィンドウを非活動状態にし、一番下のウィンドウにします。この場合、ZORDER 配置が使用されます。)

X'0400'
ウィンドウを最小化します。 (最大化、復元、サイズ変更、移動は無効)

X'0800'
ウィンドウを最大化します。 (最小化、復元、サイズ変更、移動は無効)

X'1000'
ウィンドウを復元します。 (最小化、最大化、サイズ変更、移動は無効)
5 ～ 6 9 ～ 12 ウィンドウ位置の X 座標を含む 16 ビット/32 ビットのワード。 (移動オプションが設定されていない場合には無視されます。)
7 ～ 8 13 ～ 16 ウィンドウ位置の Y 座標を含む 16 ビット/32 ビットのワード。 (移動オプションが設定されていない場合には無視されます。)
9 ～ 10 17 ～ 20 装置単位での X ウィンドウ・サイズを含む 16 ビット/32 ビットのワード。 (サイズ・オプションが設定されていない場合には無視されます。)
11 ～ 12 21 ～ 24 装置単位での Y ウィンドウ・サイズを含む 16 ビット/32 ビットのワード。 (サイズ・オプションが設定されていない場合には無視されます。)
13 ～ 16 25 ～ 28 ウィンドウの相対配置のためのウィンドウ・ハンドルを含む 16 ビット/32 ビットのワード。この 2 つのワードは設定オプション専用です。 (ZORDER オプションが設定されていない場合には無視されます。) 有効な値は次の通りです。

X'00000003' -- すべての兄弟ウィンドウの前に配置。

X'00000004' -- すべての兄弟ウィンドウの後ろに配置。

要求オプションの値が X'02' (状況照会) の場合:

バイト位置 定義
標準 拡張  
3 ～ 4 7 ～ 8 要求オプションが 2 (拡張状況照会) の場合には、X'0000' を含む 16 ビット/32 ビットのワード。要求オプションが状況照会の場合、可能な戻り値は以下のコードです。複数の状態も可能です。

X'0008'
ウィンドウが可視状態です。

X'0010'
ウィンドウは不可視状態です。

X'0080'
ウィンドウは活動状態です。

X'0100'
ウィンドウは非活動状態です。

X'0400'
ウィンドウは最小化されています。

X'0800'
ウィンドウは最大化されています。
5 ～ 6 9 ～ 12 ウィンドウ位置の X 座標を含む 16 ビット/32 ビットのワード。 (移動オプションが設定されていない場合には無視されます。)
7 ～ 8 13 ～ 16 ウィンドウ位置の Y 座標を含む 16 ビット/32 ビットのワード。 (移動オプションが設定されていない場合には無視されます。)
9 ～ 10 17 ～ 20 装置単位での X ウィンドウ・サイズを含む 16 ビット/32 ビットのワード。 (サイズ・オプションが設定されていない場合には無視されます。)
11 ～ 12 21 ～ 24 装置単位での Y ウィンドウ・サイズを含む 16 ビット/32 ビットのワード。 (サイズ・オプションが設定されていない場合には無視されます。)
13 ～ 16 25 ～ 28 ウィンドウの相対配置のためのウィンドウ・ハンドルを含む 16 ビット/32 ビットのワード。この 2 つのワードは設定オプション専用です。 (ZORDER オプションが設定されていない場合には無視されます。) 有効な値は次の通りです。

X'00000003' -- すべての兄弟ウィンドウの前に配置。

X'00000004' -- すべての兄弟ウィンドウの後ろに配置。

要求オプション値が X'03' (拡張状況照会) の場合:

バイト位置 定義
標準 拡張  
3 ～ 4 7 ～ 8 要求オプションが 3 (拡張状況照会) の場合には、X'0000' を含む 16 ビット/32 ビットのワード。要求オプションが拡張状況照会の場合、可能な戻り値は以下のコードです。複数の状態も可能です。

X'0008'
ウィンドウが可視状態です。

X'0010'
ウィンドウは不可視状態です。

X'0080'
ウィンドウは活動状態です。

X'0100'
ウィンドウは非活動状態です。

X'0400'
ウィンドウは最小化されています。

X'0800'
ウィンドウは最大化されています。
5 ～ 6 9 ～ 10 X 方向の現行のフォント・サイズを含む 16 ビット/32 ビットのワード。値はスクリーン・ペル単位です。
7 ～ 8 11 ～ 12 Y 方向の現行のフォント・サイズを含む 16 ビット/32 ビットのワード。値はスクリーン・ペル単位です。
9 ～ 12 13 ～ 16 予約済み。この値は常に 0 です。
13 ～ 14 17 ～ 18 表示スペースの最初の可視文字の行番号を含む 16 ビット/32 ビットのワード。固定サイズ・フォント・オプションが無効で、表示スペースがいくらか隠れるようにウィンドウ・サイズが変更されていない場合、この値は通常 1 です。
15 ～ 16 19 ～ 20 表示スペースの最初の可視文字の列番号を含む 16 ビット/32 ビットのワード。
17 ～ 20 21 ～ 24 セッションの表示スペース・ウィンドウ・ハンドルを含む 16 ビット/32 ビットのワード。

戻りパラメーター


戻りコード 説明
0 Window Status 関数は正常終了しました。
1 表示スペースが正しくないか、または接続されていません。
2 無効なオプションが指定されました。
9 システム・エラーが発生しました。
12 セッションが停止しました。

使用上の注意

論理端末 (LT) のウィンドウは文字セルを使用しています。 LT ウィンドウのサイズを再変更する場合、文字セルの切り捨てを防ぐために LT は数を切り上げます。必要なサイズや位置が要求されたものとわずかに異なることがあります。設定オプションと照会オプションに従い、最終的なプレゼンテーション・マネージャー・ウィンドウの位置とサイズを決定してください。すべての x 座標と y 座標の位置とサイズはペル単位です。

Write Structured Fields (127)


3270 5250 VT
YES NO NO

Write Structured Fields 関数により、アプリケーションは構造化フィールド・データをホスト・アプリケーションに書き込みます。呼び出しで S (同期) を指定した場合、 Write Structured Fields 関数が完了するまで、アプリケーションに制御が戻されません。呼び出しで A (非同期) を指定した場合、その呼び出しの直後に、アプリケーションに制御が戻されます。呼び出しで M を指定した場合、その呼び出しの直後に、アプリケーションに制御が戻されます。アプリケーションは、このメッセージを待機します。いずれの場合 (S、A、または M) でも、アプリケーションにより、ホストに対するデータが入るバッファー・アドレスが設定されます。

この関数が非同期に正常終了するためには、以下のステートメントを適用します。

パラメーター・リストの戻りコード・フィールドには、要求された入出力の結果が含まれていない場合もあります。戻りコードが 0 でない場合、要求は失敗しています。アプリケーションでは、戻りコードに応じて、適切な処置を行わなければなりません。

この要求に対する戻りコードが 0 である場合、アプリケーションで、この関数呼び出しと共に戻される要求 ID を使用して、 Get Request Completion 関数呼び出しを発行し、その要求 ID に関連する関数が終了したかどうかを判別します。 Get Request Completion 関数呼び出しによって、以下の情報が戻されます。

  1. 関数要求 ID
  2. 非同期要求からのデータ・ストリング・アドレス
  3. データ・ストリングの長さ
  4. 完了した関数の戻りコード

前提呼び出し

Connect for Structured Fields (120) Allocate Communication Buffer (123)

呼び出しパラメーター


  標準インターフェース 拡張インターフェース
関数番号 必ず 127 にしてください。
データ・ストリング 次の表を参照してください。
長さ 8、10、14 のいずれかにしてください。 必ず 20 にしてください。
PS 位置 NA

呼び出しデータ・ストリングには次のものがあります。

バイト位置 定義
標準 拡張
1 1 表示スペースの 1 文字の短縮名 (PSID)。
2 ～ 4 予約済み。
2 5 S、A、M のいずれか

S =
同期。制御は、読み取りが満たされるまでアプリケーションに戻りません。

A =
非同期。制御は、アプリケーション (イベント・オブジェクト待機可能) に即時に戻されます。

M =
非同期。制御は、アプリケーション (メッセージ待機可能) に即時に戻されます。
6 予約済み。
3 ～ 4 7 ～ 8 2 バイトの Destination/Origin ID
5 ～ 8 9 ～ 12 データが書き込まれる 4 バイトのバッファー・アドレス。 Allocate Communications Buffer (123) 関数を使用してバッファーを取得する必要があります。
9 ～ 10 13 ～ 16 予約済み。
11 ～ 12 17 ～ 20 "M" をバイト位置 5 (16 ビットの場合は 2) に指定した場合、メッセージを受け取るウィンドウのウィンドウ・ハンドルを設定してください。メッセージは、RegisterWindowMessage ("PCSHLL") の戻り値 (0 以外) です。
13 ～ 14 この位置にあるデータは EHLLAPI によって無視されます。ただし、移行プログラムがこの位置にデータを指定しても、エラーは発生しません。このデータはアプリケーションの移行時に互換性を保つために設けられています。

戻りパラメーター

この関数はデータ・ストリングおよび戻りコードを戻します。

データ・ストリング:
A (非同期) をバイト位置 5 (標準インターフェースの場合は 2) に指定して、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
9 ～ 10 13 ～ 14 2 バイトの関数要求 ID。この関数要求 ID は、この関数呼び出しの完了を判別するために Get Request Completion (125) 関数で使用します。
15 ～ 16 予約済み。
17 ～ 20 EHLLAPI によってイベント・オブジェクト・アドレスが戻される 4 バイト値。アプリケーションは、このイベント・オブジェクトを待ちます。イベント・オブジェクトがクリアされる場合、アプリケーションは Get Request Completion (125) 関数呼び出しを発行して、Write Structured Fields 要求の結果を取得しなければなりません(32 ビットのみ。)
注:
イベント・オブジェクトは、非同期要求が正常終了するたびに戻されます。イベント・オブジェクトは再使用しないでください。要求ごとに新しいイベント・オブジェクトが戻され、そのイベント・オブジェクトはその要求の間だけ有効です。

データ・ストリング:
M (非同期メッセージ・モード) をバイト位置 5 (標準インターフェースの場合は 2) に指定して、関数が正常終了した場合、以下のデータ・ストリングが戻されます。

バイト位置 定義
9 ～ 10 13 ～ 14 2 バイトの関数要求 ID。この関数要求 ID は、この関数呼び出しの完了を判別するために Get Request Completion (125) 関数で使用します。
15 ～ 16 予約済み。
11 ～ 12 17 ～ 18 非同期メッセージ・モードのタスク ID。
19 ～ 20 予約済み。
注:
関数が正常終了した場合、アプリケーション・ウィンドウはメッセージを受け取ります。メッセージは、RegisterWindowMessage(PCSHLL) の戻り値です。wParam パラメーターには、関数呼び出しによって戻されたタスク ID が入ります。 lParam パラメーターの HIWORD には戻りコード 0 (関数の正常終了) が、LOWORD には関数番号 127 が入ります。

戻りコード:
以下のコードが定義されています。

戻りコード 説明
0 Write Structured Fields 関数は正常終了しました。
1 無効なホスト表示スペースの短縮セッション ID が指定されたか、またはホスト表示スペースが接続されていません。
2 パラメーター指定でエラーが発生しました。
9 システム・エラーが発生しました。
11 リソースが使用できません。(メモリーが使用できません。)
34 インバウンドでホストに送信されたメッセージが取り消されました。
35 ホストからのアウトバウンド送信が取り消されました。
36 要求はリジェクトされました。ホストと接続できません。
37 関数は失敗しました。ホストのインバウンド送信は使用できません。

使用上の注意

  1. 戻りコード 35。これは、ホストからのアウトバウンド送信が取り消された後に Read Structured Fields または Write Structured Fields が要求された場合に戻されます。アプリケーションで修正処置を行う必要があります。
  2. 戻りコード 36。この場合、アプリケーションをエミュレーション・プログラムから切断してから再接続して、ホストとの通信を再確立する必要があります。アプリケーションで修正処置を行う必要があります。
  3. 戻りコード 37。これはホスト・インバウンドが使用不可の場合に戻されます。
  4. EHLLAPI では、アプリケーションごとに 20 までの非同期要求を未処理にすることができます。 20 を超える非同期要求が試行されると、リソースが使用不可であることを示す戻りコード (RC=11) が戻されます。
  5. IBM グローバル・ネットワーク接続を使用する場合、非同期要求の最大数は 10 です。

構造化フィールド・データの形式は以下のとおりです。

オフセット 長さ 内容
0 1 ワード X'0000'
2 1 ワード m (メッセージの長さ。すなわち、メッセージ中のデータのバイト数。この数は 8 バイトを含むメッセージ・ヘッダーの接頭部を除いたものです。) この値はアプリケーションによって設定しなければなりません。
4 1 ワード X'0000'
6 1 ワード X'0000'
8 8 バイト 先頭の (または唯一の) 構造化フィールド・メッセージの長さ。
10 1 バイト 構造化フィールド・メッセージの長さ以外の最初のバイト。



·
·
·
m+7 1 バイト 構造化フィールド・メッセージの末尾のバイト。

バイト 0 から 7 は、バッファー・ヘッダーです。最初のこれらの 8 バイトは、エミュレーション・プログラムで使用されます。バッファーのユーザー・セッションは、オフセット 8 からです。バイト 8 および 9 は、最初の構造化フィールドのバイト数が入っています。構造化フィールド・メッセージには複数の構造化フィールドを含むことができ、バイト 8 および 9 の 2 バイトを含みます。バイト 8 から m +7 は、ホストに送信される構造化フィールド・メッセージのために使用されます。

同期要求

Write Structured Fields が同期要求 (データ・ストリング中の S オプション) された際には、制御は要求が満たされた後に限りアプリケーションに戻されます。アプリケーションでは以下のことを想定できます。

非同期要求

Write Structured Fields が非同期要求 (データ・ストリング中の A オプション) された際には、アプリケーションでは以下のことを想定できません。

非同期要求がなされた際には、EHLLAPI は以下の値を戻します。

これらは、非同期の Write Structured Fields 呼び出しを完了させるために使用します。

非同期の Write Structured Fields 関数呼び出しの結果を判別するためには、次のステップを行わなければなりません。

非同期要求

Write Structured Fields が非同期要求 (データ・ストリング中の M オプション) された際には、アプリケーションで以下のことを想定できません。

M オプションを指定して非同期要求がなされた際には、EHLLAPI は以下の値を戻します。

これらは、非同期の Write Structured Fields 呼び出しを完了させるために使用します。

[ ページのトップ | 前ページ | 次ページ | 目次 | 索引 ]