プログラミング・リファレンス

by user

on 28 марта 2017

Category: Documents

>> Downloads: 4

views

Report

Comments

Description

Download プログラミング・リファレンス

Transcript

プログラミング・リファレンス

CICS Transaction Gateway
򔻐򗗠򙳰
プログラミング・リファレンス
バージョン 6.1
作成日付: 2005年12月2日
SD88-6665-00
(英文原典：SC34-6674-00)
CICS Transaction Gateway
򔻐򗗠򙳰
プログラミング・リファレンス
バージョン 6.1
作成日付: 2005年12月2日
SD88-6665-00
(英文原典：SC34-6674-00)
作成日付: 2005年12月2日
ご注意!
本書および本書で紹介する製品をご使用になる前に、 291 ページの『特記事項』に記載されている情報をお読み
ください。
本書は、CICS Transaction Gateway のバージョン 6.1 (プログラム番号 5655-M69) に適用されます。また、新版で特に
明示されない限り、これ以降のすべてのバージョン、リリース、および修正レベルにも適用されます。
本書は、SC34-6375の改訂版です。本文に技術的な変更がある場合は、その個所の左側に縦線を引いて示してありま
す。
本マニュアルに関するご意見やご感想は、次の URL からお送りください。今後の参考にさせていただきます。
http://www.ibm.com/jp/manuals/main/mail.html
なお、日本 IBM 発行のマニュアルはインターネット経由でもご購入いただけます。詳しくは
http://www.ibm.com/jp/manuals/
の「ご注文について」をご覧ください。
(URL は、変更になる場合があります)
お客様の環境によっては、資料中の円記号がバックスラッシュと表示されたり、バックスラッシュが円記号と表示され
たりする場合があります。
原典：
SC34–6674–00
CICS Transaction Gateway
Programming Reference
Version 6.1
発行：
日本アイ・ビー・エム株式会社
担当：
ナショナル・ランゲージ・サポート
第1刷 2005.12
この文書では、平成明朝体™W3、平成明朝体™W7、平成明朝体™W9、平成角ゴシック体™W3、平成角ゴシック体™
W5、および平成角ゴシック体™W7を使用しています。この(書体*)は、
（財）日本規格協会と使用契約を締結し使用して
いるものです。フォントとして無断複製することは禁止されています。
注*
平成明朝体™W3、平成明朝体™W7、平成明朝体™W9、平成角ゴシック体™W3、
平成角ゴシック体™W5、平成角ゴシック体™W7
© Copyright International Business Machines Corporation 1989, 2005. All rights reserved.
© Copyright IBM Japan 2005
作成日付: 2005年12月2日
目次
本書について . . . . . . . . . .
本書の対象読者 . . . . . . . . . .
本書で使用する規約および用語 . . . .
インストール・パス . . . . . . .
ディレクトリー区切り文字 . . . .
オペレーティング・システム固有の用語
変更の要約
.
.
.
.
.
第 1 章 COM. . . . .
Buffer COM クラス . . .
インターフェースの選択
オブジェクトの作成 . .
メソッド . . . . .
Connect COM クラス . .
インターフェースの選択
オブジェクトの作成 . .
メソッド . . . . .
ECI COM クラス . . .
インターフェースの選択
オブジェクトの作成 .
メソッド . . . . .
EPI COM クラス . . .
インターフェースの選択
オブジェクトの作成 .
メソッド . . . . .
Field COM クラス . . .
インターフェースの選択
メソッド . . . . .
Flow COM クラス . . .
インターフェースの選択
オブジェクトの作成 .
メソッド . . . . .
Map COM クラス . . .
インターフェースの選択
オブジェクトの作成 .
メソッド . . . . .
Screen COM クラス . .
インターフェースの選択
メソッド . . . . .
SecAttr COM クラス . .
.
.
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
© Copyright IBM Corp. 1989, 2005
.
.
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
.
. vii
. vii
. vii
. . x
. . x
. . x
.
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. .
. xi
. 1
. 1
. 1
. 1
. 2
. 4
. 4
. 4
. 5
. 10
. 11
. 11
. 11
. 13
. 14
. 14
. 14
. 17
. 18
. 18
. 23
. 23
. 23
. 24
. 26
. 27
. 27
. 27
. 28
. 28
. 29
. 31
インターフェースの選択
メソッド . . . . .
SecTime COM クラス . .
インターフェースの選択
メソッド . . . . .
Session COM クラス . .
インターフェースの選択
オブジェクトの作成 .
メソッド . . . . .
Terminal COM クラス. .
インターフェースの選択
オブジェクトの作成 .
メソッド . . . . .
UOW COM クラス. . .
インターフェースの選択
オブジェクトの作成 .
メソッド . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
31
32
32
33
33
34
34
34
35
36
36
36
37
46
46
46
47
第 2 章 Java . . . . . . . . . . . 49
クラス/インターフェースのページ. . . . . 49
使用ページ . . . . . . . . . . . . 50
ツリー (クラス階層) . . . . . . . . . 50
索引ページ . . . . . . . . . . . . 50
第 3 章 C++ . . . . . . .
Ccl クラス . . . . . . . .
列挙型 . . . . . . . . .
CclBuf クラス . . . . . . .
CclBuf コンストラクター . .
public メソッド . . . . . .
列挙型 . . . . . . . . .
CclConn クラス . . . . . . .
CclConn コンストラクター . .
public メソッド . . . . . .
列挙型 . . . . . . . . .
CclECI クラス . . . . . . .
CclECI コンストラクター (保護)
public メソッド . . . . . .
CclEPI クラス . . . . . . .
CclEPI コンストラクター . .
public メソッド . . . . . .
. . . . 51
. . . . 51
. . . . 51
. . . . 51
. . . . 52
. . . . 53
. . . . 57
. . . . 57
. . . . 58
. . . . 59
. . . . 63
. . . . 63
. . . . 63
. . . . 64
. . . . 65
. . . . 66
. . . . 66
iii
作成日付: 2005年12月2日
列挙型 . . . . . . . .
CclException クラス . . . .
public メソッド . . . . .
CclField クラス . . . . . .
public メソッド . . . . .
列挙型 . . . . . . . .
CclFlow クラス . . . . . .
CclFlow コンストラクター .
public メソッド . . . . .
列挙型 . . . . . . . .
CclMap クラス . . . . . .
CclMap コンストラクター .
public メソッド . . . . .
protected メソッド . . . .
CclScreen クラス . . . . .
public メソッド . . . . .
列挙型 . . . . . . . .
CclSecAttr . . . . . . . .
public メソッド . . . . .
CclSecTime . . . . . . .
public メソッド . . . . .
CclSession クラス . . . . .
CclSession コンストラクター
public メソッド . . . . .
列挙型 . . . . . . . .
CclTerminal クラス . . . . .
CclTerminal コンストラクター
public メソッド . . . . .
列挙型 . . . . . . . .
CclUOW クラス. . . . . .
CclUOW コンストラクター .
public メソッド . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
第 4 章 C および COBOL . . . . .
外部呼び出しインターフェース . . . .
CICS_ExternalCall ECI_Parms . . . .
CICS_ExternalCall の呼び出しタイプ .
ECI 状況ブロック. . . . . . . .
CICS_EciListSystems NameSpace Systems
List . . . . . . . . . . . .
外部表示インターフェース . . . . . .
EPI 定数およびデータ構造 . . . . .
EPI 関数 . . . . . . . . . . .
EPI イベント . . . . . . . . .
外部セキュリティー・インターフェース .
ESI の定数およびデータ構造 . . . .
iv
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
68
68
69
70
70
74
75
76
76
79
80
80
80
81
82
82
84
84
85
85
85
87
87
87
88
88
89
91
97
98
99
99
.
.
.
.
.
101
101
101
104
132
.
.
.
.
.
.
.
133
134
134
140
167
170
170
ESI 関数 .
.
.
.
.
.
.
.
.
.
.
. 172
第 5 章 ECI と EPI の出口 . . . . . . 181
ECI 出口の解説 . . . . . . . . . . 181
識別トークン . . . . . . . . . . 182
EPI 出口の解説 . . . . . . . . . . 192
CICS_EpiInitializeExit . . . . . . . . 194
CICS_EpiTerminateExit . . . . . . . 195
CICS_EpiAddTerminalExit . . . . . . 196
CICS_EpiTermIdExit . . . . . . . . 198
CICS_EpiTermIdInfoExit . . . . . . . 199
CICS_EpiStartTranExtendedExit . . . . . 200
CICS_EpiStartTranExit . . . . . . . 201
CICS_EpiReplyExit. . . . . . . . . 202
CICS_EpiDelTerminalExit . . . . . . 203
CICS_EpiGetEventExit . . . . . . . 204
CICS_EpiSystemIdExit . . . . . . . 205
CICS_EpiTranFailedExit . . . . . . . 207
付録 A. COM グローバル定数 .
.
.
.
. 209
付録 B. COM EPI 固有の定数 . . . . . 211
同期タイプ . . . . . . . . . . . . 211
CclEPI の状態 . . . . . . . . . . . 211
CclSession の状態 . . . . . . . . . . 211
CclTerminal の状態 . . . . . . . . . 212
CclTerminal ATI の状態 . . . . . . . . 212
CclTerminal EndTermReasons . . . . . . 212
CclTerminal サインオン・タイプ . . . . . 213
CclScreen AID キー・コード . . . . . . 213
CclField 保護状態属性 . . . . . . . . 214
CclField 数値属性 . . . . . . . . . . 214
CclField 輝度属性 . . . . . . . . . . 214
CclField 変更属性 . . . . . . . . . . 215
CclField 強調表示属性 . . . . . . . . 215
CclField 透過性属性 . . . . . . . . . 215
CclField カラー属性 . . . . . . . . . 215
付録 C. COM ECI 定数 . . . . . . . 217
同期タイプ . . . . . . . . . . . . 217
フロー状況タイプ . . . . . . . . . . 217
接続状況コード . . . . . . . . . . 217
付録 D. COM エラー・コードの解説 .
.
. 219
付録 E. Java エンコード方式 .
.
. 223
CICS Transaction Gateway: プログラミング・リファレンス
.
.
作成日付: 2005年12月2日
付録 F. C++ 例外オブジェクト .
.
.
.
. 227
製品ライブラリーおよび関連資料 . . . . 233
CICS Transaction Gateway の資料 . . . . 233
サンプル構成資料 . . . . . . . . . . 234
Redbooks . . . . . . . . . . . . . 234
その他の役に立つ資料 . . . . . . . . 235
CICS Transaction Server の関連資料 . . . 235
Microsoft Windows 関連資料 . . . . . 235
APPC 関連資料 . . . . . . . . . 235
TCP62 関連の資料 . . . . . . . . 236
IBM からの資料の入手方法 . . . . . . 236
アクセシビリティ
.
.
.
.
.
.
.
.
資料 . . . . . . . . . . . . .
EPITerminal プロパティーのプログラマチッ
ク設定 . . . . . . . . . . . .
cicsterm . . . . . . . . . . . .
cicsterm -? コマンド . . . . . . .
端末サーブレット . . . . . . . . .
. 237
用語集 .
.
.
.
.
.
.
.
.
.
.
.
. 241
索引 .
.
.
.
.
.
.
.
.
.
.
.
. 257
.
.
.
.
.
237
237
238
238
特記事項 . . . . . . . . . . . . 291
商標 . . . . . . . . . . . . . . 292
. 237
目次
v
作成日付: 2005年12月2日
vi
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
本書について
本書では、CICS® Transaction Gateway がサポートするプログラミング言語 (Java™、
C++、C、COM)、および CICS Universal Client がサポートするプログラミング言語
(C++、C、および COM) の API について説明します。
プログラミングの方法論については、「CICS Transaction Gateway: プログラミング・ガ
イド」SD88-6664 を参照してください。 CICS Transaction Gateway での Java のプログ
ラミングについて詳しくは、本製品と一緒に配送される Javadoc を参照してください。
本書の対象読者
本書は、CICS Transaction Gateway および CICS Universal Client のプログラミングにか
かわっている方を対象としています。
本書をお読みいただくには、CICS Transaction Gateway または CICS Universal Client が
稼働するオペレーティング・システムについて、十分精通していることが前提になりま
す。
インターネット用語の知識も役に立ちます。
本書で使用する規約および用語
本製品を使用してビジネス・ソリューションを作成する際には、CICS Transaction
Gateway の内部および外部にあるさまざまな部分が使用されます。 viii ページの図 1
は、考えられるシナリオのいくつかと、使用している用語を示しています。
© Copyright IBM Corp. 1989, 2005
vii
作成日付: 2005年12月2日
図 1. CICS Transaction Gateway の用途、および関連する用語
図 1 で使用されている用語について、以下で説明します。
ゲートウェイ・デーモン
リモート・モードのみで使用される長時間実行の Java プロセス。ゲートウェ
イ・デーモンは、リモート Java クライアント・アプリケーションからのネッ
トワーク要求を listen する。 UNIX®、Windows® および Linux® プラットフ
ォーム上でクライアント・デーモンの機能、または z/OS® 上で EXCI を使
用して、CICS に対してこれらの要求を出す。ゲートウェイ・デーモンは、プ
ロトコル・リスナー・スレッド、接続マネージャー・スレッド、および Worker
スレッドを実行する。その構成には、ctg.ini の GATEWAY セクション (お
よび z/OS では STDENV ファイルまたは ctgenvvar スクリプト) を使用す
る。
viii
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
クライアント・デーモン
クライアント・デーモン (プロセス cclclnt) は、 UNIX、 Windows および
Linux 上にのみ存在する。 CICS サーバーへのネットワーク接続を管理する。
クライアント・デーモンは、ECI、EPI、および ESI 要求を処理し、CICS サー
バーとの間で適切なフローの送受信を行って、アプリケーションの要求を満た
す。その構成には、ctg.ini の CLIENT セクションを使用する。
ゲートウェイ・クラス
CICS でのサービスを呼び出すために Java クライアント・アプリケーションが
使用する Java クラス・ライブラリー。
外部 CICS インターフェース (EXCI)
CICS Transaction Server for z/OS が提供する MVS® アプリケーション・プロ
グラミング・インターフェースで、非 CICS プログラムが CICS プログラムを
呼び出したり、 COMMAREA を使用してデータを送受信できるようにする。
CICS アプリケーション・プログラムは、別の CICS プログラムのリンク先で
あるものとして呼び出される。 EXCI は、CICS Transaction Gateway for z/OS
による通信インターフェースとして使用される。外部呼び出しインターフェー
ス (ECI) External Call Interface (ECI) と比較。
クライアント API
クライアント・デーモンの機能を用いて、クライアント・アプリケーション
が CICS のサービスを呼び出すために使用するインターフェース。外部呼び出
しインターフェース、外部表示インターフェースおよび外部セキュリティ
ー・インターフェースを参照。
クライアント・アプリケーション
サポートされているプログラム言語 (Java を除く) で書かれており、クライア
ント API を使用するユーザー・アプリケーション。
Java クライアント・アプリケーション
Java で書かれ、サーブレットおよびエンタープライズ Bean を含む、ゲートウ
ェイ・クラスを使用するユーザー・アプリケーション。
ローカル・モード
CICS Transaction Gateway ローカル・プロトコルの使用を記述した用語。ゲー
トウェイ・デーモンはローカル・モードでは使用されない。
リモート・モード
ゲートウェイ・デーモンへ接続するためにサポートされる CICS Transaction
Gateway ネットワーク・プロトコルの 1 つの用途を記述した用語。ゲートウェ
イ・デーモンを参照。
本書について
ix
作成日付: 2005年12月2日
インストール・パス
製品をインストールしたディレクトリーを示すために、ファイル・パスで
<install_path> という用語を使用します。デフォルトのインストール場所については、
ご使用のオペレーティング・システム用の「CICS Transaction Gateway: 管理」を参照し
てください。
ディレクトリー区切り文字
本書では、ディレクトリー・パス名の参照には Microsoft® Windows の規則を使用して
おり、UNIX および Linux オペレーティング・システムで使用されるスラッシュ (/) の
代わりに、バックスラッシュ (\) を区切り文字として使用しています。
オペレーティング・システム固有の用語
特に指定のない限り、用語 Windows は Windows 2000、Windows 2003、および
Windows XP を示します。
用語 Windows 端末サーバーは、端末サービス機能が使用可能なサーバーを意味して
います。
x
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
変更の要約
本書は、SC34-6375の改訂版です。本文に技術的な変更がある場合は、その個所の左側に
縦線を引いて示してあります。
© Copyright IBM Corp. 1989, 2005
xi
作成日付: 2005年12月2日
xii
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
第 1 章 COM
Buffer COM クラス
CclOBuffer オブジェクトは、メモリー内にデータ域を持っており、情報の保持のために
使用することができます。 CclOBuffer オブジェクト特有の使い方として、CICS サーバ
ー間とのデータの受け渡しに使用する COMMAREA を持っています。
CclOBuffer オブジェクトで使用するデータは、主にバイト (2 進) データを対象として
います。一般に、COMMAREA には、CICS サーバーの C プログラムによって作られ
ることが多い、アプリケーション固有のデータ構造が入っています。 Visual Basic で 2
進データを処理する場合にお勧めする方法は、現在では、バイト・データ・タイプで
す。 SetData および Data メソッドを使用すると、CclOBuffer オブジェクトの内容が
バイト配列としてアクセスできるようになります。 CclOBuffer オブジェクトは、スト
リング・データとして使用でき、ストリングは 1 バイト ANSI 文字として保管されま
すが、コード・ページ変換や DBCS はサポートしていません。 32 ビット環境では、
Visual Basic は 2 バイトの Unicode 文字表現を使用するため、COM クラスは Unicode
と 1 バイト ANSI 間で変換を行うことに注意してください。
CclOBuffer オブジェクトが作成されると、そのバッファーとしてメモリー領域が割り振
られます。このバッファーの長さは、SetLength メソッドを通じて明示的に設定できま
す。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOBuf
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
set var = CreateObject("Ccl.Buffer")
set var = New CclOBuf
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
© Copyright IBM Corp. 1989, 2005
1
COM クラス: Buffer
作成日付: 2005年12月2日
メソッド
AppendString
AppendString(string as String)
string
ソース・ストリング。
ストリングを Ccl.Buffer オブジェクトの既存のデータに付加します。
Data
Data() as Variant
バッファーの内容をバイト配列として戻します。
ExtractString
ExtractString (offset as Integer[,
length as Integer]) as String
offset
データ域へのオフセット。
length
(オプション) 抽出されるストリングの長さ (バイト)。
指定されたオフセットで始まるデータ域から、ストリングを戻します。
length の指定がない場合は、ExtractString は、最初のヌル終了文字を見つけるまで、デ
ータを戻します。 length を指定した場合は、ExtractString は、ストリング内にヌルが
あればそれも含めて、要求されたバイト数を戻します。
InsertString
InsertString (offset as Integer,
string as String)
offset
ストリングが挿入されるデータ域内のオフセット。
string
ソース・ストリング。
2
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Buffer
データ域の指定されたオフセットに、指定されたストリングを挿入します。
Length
Length() as Integer
データ域の長さ (バイト) を戻します。
Overlay
Overlay (offset as Integer,
string as String)
offset
ストリングが挿入されるデータ域内のオフセット。
string
ソース・ストリング
データ域の指定されたオフセットから、指定されたストリングでオーバーレイします。
SetData
SetData(array as Variant)
array
ソース・データを含んでいる配列。
指定された配列をバッファーにコピーします。バイト、整数、および長形式の配列がサ
ポートされます。
SetLength
SetLength(length as Integer)
length
データ域の新しい長さ (バイト)。
データ域の現在の長さを変更します。バッファー・オブジェクトの長さを増やした場
合、余分なスペースはヌルで埋められます。クライアント・デーモンは、CICS サーバ
ーにバッファーを送信する前にすべてのヌルを切り捨てます。
第 1 章 COM
3
COM クラス: Buffer
作成日付: 2005年12月2日
SetString
SetString(string as String)
string
ソース・ストリング
指定されたストリングをオブジェクトにコピーします。
String
String() as String
Ccl.Buffer オブジェクトの内容をストリングとして戻します。
Connect COM クラス
Connect COM クラスを使用して、クライアントと指定されたサーバー間の ECI 接続の
保守および表示を行います。オプションとして、サーバーへのアクセスがユーザー ID
とパスワードによって制御されます。このクラスでは、サーバー内のプログラムを呼び
出したり、接続状態に関する情報を得ることができます。
Details メソッドおよびオプションとして TranDetails メソッドを使用し、 Connect
COM クラスを初期化してはじめて、CICS への呼び出しでこのクラスを使用することが
できます。
クライアントとサーバー間で対話を行う場合は、CclOFlow オブジェクトおよび
CclOConnect オブジェクトが必要になります。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOConn
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
4
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Connect
set var = CreateObject("Ccl.Connect")
set var = New CclOConn
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
メソッド
AlterSecurity
AlterSecurity(newUserid as String, newPassword as String)
newUserid
新規のユーザー ID。
newPassword
新規のユーザー ID に対応する新規パスワード。
次のリンク呼び出しで使用するユーザー ID とパスワードを設定します。
Cancel
Cancel(flow as Object)
または
Cancel(flow as CclOFlow)
flow
クライアント/サーバー呼び出しを制御するために使用する CclOFlow オブジェク
ト。
この接続に関連したサーバーに対して以前に出された Changed 呼び出しをすべて取り
消します。
Changed
Changed(flow as Object)
または
Changed(flow as CclOFlow)
flow
クライアント/サーバー呼び出しを制御するために使用する CclOFlow オブジェク
ト。
第 1 章 COM
5
COM クラス: Connect
作成日付: 2005年12月2日
現行接続状況が変更になったときには、クライアントに通知するようサーバーに要求し
ます。この接続に対して未解決の Changed 呼び出しがある場合は、その呼び出しは無
視されます。
ChangePassword
ChangePassword (newPassword as String) as Object
または
ChangePassword (newPassword as String) as CclOSecAttr
newPassword
新規パスワード
接続オブジェクトが持っているパスワードと、接続オブジェクトが持っているユーザー
ID 用に外部セキュリティー・マネージャーが記録しているパスワードを、クライアン
ト・アプリケーションが変更できるようにします。外部セキュリティー・マネージャー
は、接続オブジェクトによって定義されたサーバーにあるものと見なされます。エラー
が生じない場合は、CclOSecAttr オブジェクトが戻されます。
Details
Details (serverName as String,
userId as String,
password as String)
serverName
サーバーの名前。名前が指定されていない場合は、デフォルトのサーバー - ゲート
ウェイ初期設定ファイルで指定された最初のサーバー - が使用されます。この名前
は、ServerName メソッドを使用してサーバーを最初に呼び出した後、見つけるこ
とができます。長さは、ブランクを埋め込むことによって、8 文字に調整されま
す。
userId
必要であれば、ユーザー ID。長さは、ブランクの埋め込みによって、16 文字に調
整されます。
password
必要であれば、userID に指定されたユーザー ID に対応するパスワード。長さは、
ブランクの埋め込みによって、16 文字に調整されます。
このメソッドを使用して、CICS サーバーの詳細を指定します。 CICS サーバーとの対
話は、Link、Status または Changed メソッドが呼び出されるまで行われません。接続
6
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Connect
が状況呼び出しにのみ使用される場合、あるいはサーバーにセキュリティーがない場合
は、ユーザー ID とパスワードは不要です。
Link
Link (flow as Object,
programName as String,
commArea as Object,
unitOfWork as Object)
または
Link (flow as CclOFlow,
programName as String,
commArea as CclOBuf,
unitOfWork as CclOUOW)
flow
クライアント/サーバー呼び出しを制御するために使用する CclOFlow オブジェク
ト。
programName
呼び出しを受けているサーバー・プログラムの名前。必要であれば、ブランクの埋
め込みまたは切り捨てによって、長さは 8 文字に調整されます。
commArea
呼び出されたプログラムに受け渡すデータを COMMAREA に持つ CclOBuffer オ
ブジェクト。 COMMAREA を送信しない場合は、ヌル値を指定する必要がありま
す。
unitOfWork
この呼び出しが関連している作業単位 (UOW) を識別する CclOUOW オブジェク
ト。 UOW を使用しない場合は、ヌル値を指定する必要があります。
指定されたプログラムをサーバーに呼び出します。サーバー・プログラムは、着信呼び
出しを EXEC CICS LINK 呼び出しと見なします。
MakeSecurityDefault
MakeSecurityDefault()
接続オブジェクトの構造で指定されているように、このオブジェクトの現行ユーザー ID
とパスワードが、サーバーに渡される ECI および EPI 要求のデフォルトになることを
クライアントに通知します。
第 1 章 COM
7
COM クラス: Connect
作成日付: 2005年12月2日
Password
Password() as String
CclOConnect オブジェクトが持つパスワードを、スペースで埋めて戻します。
ServerName
ServerName() as String
CclOConnect オブジェクトが持っており、ゲートウェイ初期設定ファイルに示されてい
るサーバー・システムの名前を戻します。あるいは、デフォルト・サーバーが使用され
る予定なのに、まだ呼び出しが行われていない場合はブランクが戻されます。
ServerStatus
ServerStatus() as Integer
または
ServerStatus() as CclConnectStatusCodes
以前の status または changed 要求によって設定されたサーバー接続の状況を戻しま
す。使用される値は以下のとおりです。
cclUnknown
CICS サーバー状況は不明です。
cclAvailable
CICS サーバーは使用可能です。
cclUnavailable
CICS サーバーは使用不可です。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
ServerStatusText
ServerStatusText() as String
以前の status または changed 要求によって設定された、サーバーの可用性を示すスト
リングを戻します。
8
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Connect
Status
Status(flow as Object)
または
Status(flow as CclOFlow)
flow
クライアント/サーバー呼び出しを制御するために使用する CclOFlow オブジェク
ト。
サーバー接続の状況を要求します。
TranDetails
TranDetails (runTran as String,
attachTran as String)
runTran
呼び出されたプログラムを実行する CICS トランザクション。デフォルトでは、デ
フォルトのサーバー・トランザクションを使用します。長さは、ブランクの埋め込
みによって、4 文字に調整されます。
attachTran
呼び出されたプログラムが接続される CICS トランザクション。デフォルトでは、
デフォルト CPMI を使用します。長さは、ブランクの埋め込みによって、4 文字に
調整されます。
このメソッドを使用して、CICS サーバーに追加情報を指定します。情報はオプション
ですが、この情報を使用すると、プログラムが CICS サーバーで実行する環境に影響を
与えることができます。
注: TranDetails メソッドを使用する前に Details メソッドを使用して、CICS サーバー
の詳細を指定します。 6 ページの『Details』を参照してください。
UnpaddedPassword
UnpaddedPassword() as String
CclOConnect オブジェクトが持っているパスワードを戻しますが、これには終わりの部
分にスペースの埋め込みはありません。
第 1 章 COM
9
COM クラス: Connect
作成日付: 2005年12月2日
UnpaddedServerName
UnpaddedServerName() as String
CclOConnect オブジェクトが持っているサーバー名を戻しますが、これには終わりの部
分にスペースの埋め込みはありません。
UnpaddedUserid
UnpaddedUserid() as String
CclOConnect オブジェクトが持っているユーザー ID を戻しますが、これには終わりの
部分にスペースの埋め込みはありません。
UserId
UserId() as String
CclOConnect オブジェクトが持っているユーザー ID をスペースで埋めて戻すか、ある
いはユーザー ID がない場合はブランクを戻します。
VerifyPassword
VerifyPassword() as Object
または
VerifyPassword() as CclOSecAttr
接続オブジェクトが持っているパスワードと、接続オブジェクトが持っているユーザー
ID 用に外部セキュリティー・マネージャーが記録しているパスワードが一致しているか
どうかを、クライアント・アプリケーションが検査できるようにします。外部セキュリ
ティー・マネージャーは、接続オブジェクトによって定義されたサーバーにあるものと
見なされます。エラーが生じない場合は、CclOSecAttr オブジェクトが戻されます。
ECI COM クラス
ECI COM クラスを使用するすべてのアプリケーションは、最初に CclOECI オブジェ
クトを作成する必要があります。
ECI COM クラスは、候補となる CICS サーバーについての詳細を提供します。また、
エラー情報を入手するために使用することもできます。
10
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: ECI
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOECI
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
set var = CreateObject("Ccl.ECI")
set var = New CclOECI
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
メソッド
ErrorFormat
ErrorFormat() as Integer
エラー・メッセージ形式の現行の設定を示す値を戻します。現行の有効な値のリストに
ついては、SetErrorFormatを参照してください。
ErrorOffset
ErrorOffset() as Long
ERR.Number メソッドで取得されたクライアント・デーモンのエラー値を、文書化され
た ExCode のエラー値に変換するために使用できる値を戻します。この方法の詳細につ
いては、「CICS Transaction Gateway: プログラミング・ガイド」を参照してください。
ErrorWindow
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
第 1 章 COM
11
COM クラス: ECI
作成日付: 2005年12月2日
ErrorWindow(display as Boolean)
display
true
エラー・ウィンドウがユーザーに対して表示されるようにします。これが
デフォルトの設定値です。
false
エラー・ウィンドウはユーザーに対して表示されません。アプリケーショ
ンは、ExCode メソッドを使用して、エラーの有無を確認する必要があり
ます。
ExCode
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
ExCode() as Integer
または
ExCode() as CclECIExceptionCodes
最後の ECI エラーを示した列挙型を戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
ExCodeText メソッドは、エラー値を記述したテキスト・ストリングを戻します。
ExCodeText
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
ExCodeText() as String
最後の ECI エラーを記述したテキスト・ストリングを戻します。
12
CICS Transaction Gateway: プログラミング・リファレンス
COM クラス: ECI
作成日付: 2005年12月2日
ServerCount
ServerCount() as Integer
ゲートウェイ初期設定ファイルで構成されているように、クライアントが接続できるサ
ーバーの候補の数を戻します。
ServerDesc
ServerDesc(index as Integer) as String
index
リスト内の接続されたサーバーの数 (1 から始まる)。
index 番目のサーバーの記述を戻します。
ServerName
ServerName(index as Integer) as String
index
リスト内の接続されたサーバーの数 (1 から始まる)。
index 番目のサーバーの名前を戻します。
SetErrorFormat
SetErrorFormat(format as Integer)
format
0
旧形式のもので、後方互換性の目的でのみ提供されています。
1
新形式のものであり、Visual Basic および VBScript Err オブジェクトで
詳細情報を提供します。この形式をお勧めします。
このメソッドを使用すると、エラー・メッセージ形式を選択できます。
EPI COM クラス
EPI COM クラスは、クライアント・デーモンの EPI 関数を初期化します。また、使用
可能な CICS サーバーに関する情報を入手できるメソッドも持っています。 CICS サー
バーに接続するための CclOTerminal オブジェクトを作成する前に、CclOEPI オブジェ
クトを作成します。 Diagnose、ExCode、および State メソッドは、エラー条件に関す
る情報を提供します。
第 1 章 COM
13
COM クラス: EPI
作成日付: 2005年12月2日
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOEPI
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
set var = CreateObject("Ccl.EPI")
set var = New CclOEPI
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
メソッド
Diagnose
Diagnose() as String
最後のエラーについての記述を含んでいる文字ストリングを戻します。
ErrorFormat
ErrorFormat() as Integer
エラー・メッセージ形式の現行の設定を示す値を戻します。現行の有効な値のリストに
ついては、 16 ページの『SetErrorFormat』を参照してください。
ErrorOffset
ErrorOffset() as Long
ERR.Number メソッドで取得されたクライアント・デーモンのエラー値を、文書化され
た ExCode のエラー値に変換するために使用できる値を戻します。この方法の詳細につ
いては、「CICS Transaction Gateway: プログラミング・ガイド」を参照してください。
14
CICS Transaction Gateway: プログラミング・リファレンス
COM クラス: EPI
作成日付: 2005年12月2日
ErrorWindow
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
ErrorWindow(display as Boolean)
display
true
エラー・ウィンドウがユーザーに対して表示されるようにします。これが
デフォルトの設定値です。
false
エラー・ウィンドウはユーザーに対して表示されません。アプリケーショ
ンは、 ExCode メソッドを使用して、エラーの有無を確認する必要があり
ます。
ExCode
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
ExCode() as Integer
または
ExCode() as CclEPIExceptionCodes
条件コードを戻します。使用される値は以下のとおりです。
cclSystemError
内部クライアント・デーモンのシステム・エラーが発生しました。
cclUnknownServer
ServerDesc または ServerName メソッドで指定された index に対応する CICS
サーバーがありません。
cclNoError
呼び出しは正常に実行されました。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
第 1 章 COM
15
COM クラス: EPI
作成日付: 2005年12月2日
ExCodeText
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
ExCodeText() as String
最新の例外について記述したテキストを含んでいるストリングを戻します。
ServerCount
ServerCount() as Integer
ゲートウェイ初期設定ファイルで構成されているように、クライアント・デーモンが接
続できるサーバーの候補の数を戻します。
ServerDesc
ServerDesc(index as Integer) as String
index
接続されたサーバーの索引番号 (1 から始まる)。
選択された CICS サーバーの記述を戻します。あるいは、指定されたサーバーのゲー
トウェイ初期設定ファイルに情報がない場合はヌル・ストリングを戻します。
ServerName
ServerName(index as Integer) as String
index
接続されたサーバーの索引番号 (1 から始まる)。
要求された CICS サーバーの名前を戻します。あるいは、指定されたサーバーのゲー
トウェイ初期設定ファイルに情報がない場合はヌル・ストリングを戻します。
SetErrorFormat
SetErrorFormat(format as Integer)
format
16
CICS Transaction Gateway: プログラミング・リファレンス
COM クラス: EPI
作成日付: 2005年12月2日
0
旧形式のもので、後方互換性の目的でのみ提供されています。
1
新形式のものであり、Visual Basic および VBScript Err オブジェクトで
詳細情報を提供します。この形式をお勧めします。
このメソッドを使用すると、エラー・メッセージ形式を選択できます。
State
State() as Integer
または
State() as CclEPIStates
EPI の状態を示す値を戻します。使用される値は以下のとおりです。
cclActive
初期化されました。
cclDiscon
終了しました。
cclError
エラー。「CICS Transaction Gateway: プログラミング・ガイド」を参照してく
ださい。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
Terminate
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
Terminate()
クライアント・デーモン EPI を制御された方法で終了します。
Field COM クラス
Field COM クラスを使用して、3270 画面の 1 つのフィールドにアクセスします。
CclOField オブジェクトは、CICS サーバーからの 3270 データが CclOScreen オブジェ
クトによって処理されるときに作成され、削除されます。
第 1 章 COM
17
COM クラス: Field
作成日付: 2005年12月2日
フィールド・オブジェクトは、CclOScreen オブジェクトの fieldbyIndex または
fieldbyPosition メソッドを呼び出すことによって戻されます。たとえば、次のとおりで
す。
set var=Screen.fieldbyIndex(1)
このクラスのメソッドによって、フィールド・テキストと属性の読み取りおよび更新を
行うことができます。更新されたフィールドは、次回の送信時に CICS サーバーに送
信されます。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOField
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
メソッド
AppendText
AppendText(textString as String)
textString
フィールドに付加されるテキスト・ストリング。
textString 内の文字を、すでにフィールド内にあるテキストの終わりに付加します。
BackgroundColor
BackgroundColor() as Integer
または
BackgroundColor() as CclColorAttributes
215 ページの『CclField カラー属性』にリストされているフィールドの背景色を示す値
を戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
18
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Field
BaseAttribute
BaseAttribute() as Integer
フィールドの 3270 基本属性を戻します。
Column
Column() as Integer
画面上のフィールドの開始位置の列番号 (左端列が 1 ) を戻します。
DataTag
DataTag() as Integer
または
DataTag() as CclModifiedAttributes
フィールド内のデータが変更されたかどうかを示す値を戻します。使用される値は以下
のとおりです。
cclModified
cclUnmodified
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
ForegroundColor
ForegroundColor() as Integer
または
ForegroundColor() as CclColorAttributes
215 ページの『CclField カラー属性』にリストされているフィールドの前景色を示す値
を戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
第 1 章 COM
19
COM クラス: Field
作成日付: 2005年12月2日
Highlight
Highlight() as Integer
または
Highlight() as CclHighlightAttributes
215 ページの『CclField 強調表示属性』にリストされている強調表示のいずれのタイプ
が使用されているかを示す値を戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
InputProt
InputProt() as Integer
または
InputProt() as CclProtAttributes
フィールドが保護されているかどうかを示す値を戻します。使用される値は以下のとお
りです。
cclProtect
cclUnprotect
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
InputType
InputType() as Integer
または
InputType() as CclNumericAttributes
フィールドが英数字であるか数字であるかを示す値を戻します。使用される値は以下の
とおりです。
cclAlphanumeric
cclNumeric
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
20
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Field
Intensity
Intensity() as Integer
または
Intensity() as CclIntensityAttributes
フィールドが標準、強調、ぼかし表示のいずれであるかを示す値を戻します。使用され
る値は以下のとおりです。
cclDark
cclNormal
cclIntense
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
Length
Length() as Integer
フィールドの全長を戻します。これは、3270 属性バイト情報の保管に使用される 1 バ
イトを含んでいます。したがって、実際のデータのスペースは、このメソッドにより戻
される値より 1 バイト小さくなります。 TextLength メソッドも参照してください。
Position
Position() as Integer
画面の左上隅からのオフセットとして、フィールドの開始位置を戻します。最上行が 0
から 79 の位置、2 番目の行が 80 から 159 までの位置、などのようになります。
ResetDataTag
ResetDataTag()
変更データ・タグ (MDT) を cclUnmodified にリセットします。
Row
Row() as Integer
画面上のフィールドの開始位置の行番号を戻します。最上行が 1 です。
第 1 章 COM
21
COM クラス: Field
作成日付: 2005年12月2日
SetBaseAttribute
SetBaseAttribute(Attribute as Integer)
Attribute
フィールドに入力される 3270 基本属性値。
3270 基本属性を設定します。
SetExtAttribute
SetExtAttribute(Attribute as Integer, Value as Integer)
Attribute
設定する拡張属性のタイプ。
Value
拡張属性の値。
拡張 3270 属性を設定します。無効な 3270 属性タイプまたは値が指定されると、パラ
メーター例外が生じます。
SetText
SetText(textString as String)
textString
フィールドに入力されるヌル終了テキスト。
textString をフィールドにコピーします。
Text
Text() as String
現在、フィールドにあるテキストを戻します。
TextLength
TextLength() as Integer
現在、フィールドにある文字数を戻します。
22
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Field
Transparency
Transparency() as Integer
または
Transparency() as CclTransparencyAttributes
215 ページの『CclField 透過性属性』にリストされているフィールドの背景透過性を示
す値を戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
Flow COM クラス
CclOFlow オブジェクトを使用して、クライアント/サーバーのペアの ECI 通信を制御し
ます。
CclOFlow オブジェクトは、それぞれのクライアントとサーバーの対話 (クライアントか
らの呼び出しとサーバーからの応答) ごとに作成され、使用後には破棄されます。
CclOFlow オブジェクトは再利用できますが、すでに使用中の CclOFlow オブジェクト
を再利用しようとするとリジェクトされます。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOFlow
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
set var = CreateObject("Ccl.Flow")
set var = New CclOFlow
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
第 1 章 COM
23
COM クラス: Flow
作成日付: 2005年12月2日
メソッド
AbendCode
AbendCode() as String
4 文字の CICS トランザクション異常終了コード。あるいは、異常終了が生じていない
場合はスペースを戻します。
CallType
CallType() as Integer
または
CallType() as CclFlowCallTypes
フローが現在実行している呼び出しのタイプを戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
CallTypeText
CallTypeText() as String
フローが現在実行している呼び出しのタイプをテキストとして戻します。
Diagnose
Diagnose() as String
フロー・オブジェクトの現在の状態を記述するテキストを戻します。
Flowid
Flowid() as Integer
このフロー・オブジェクトの固有 ID を戻します。
ForceReset
ForceReset()
フローを非アクティブにして、リセットします。一般には、このメソッドを使用して、
フローを中止した後、フロー・オブジェクトの再利用または削除の準備を行います。
24
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Flow
Poll
Poll(commArea as Object) as Boolean
または
Poll(commArea as CclOBuf) as Boolean
commArea
戻された COMMAREA が置かれる CclOBuffer オブジェクト。 COMMAREA を戻
さないようにする場合は、このパラメーターを Nothing に設定することもできま
す。
遅延同期の Backout、Cancel 、Changed、Commit、Link 、または Status 呼び出し要
求から、応答を受け取ったかどうかを示します。このメソッドは遅延同期通信に対して
のみ有効です。使用される値は以下のとおりです。
True
応答を受信しました。
False
応答は受信していません。
SetSyncType
SetSyncType(syncType as Integer)
または
SetSyncType(syncType as CclFlowSyncTypes)
syncType
この CclOFlow オブジェクトに必要な同期タイプ。使用される値は以下のとおりで
す。
cclSync
cclDSync
この CclOFlow オブジェクトに必要な同期タイプを設定します。 cclSync を使用する
と、このフローを使用する link および status 呼び出しは、CICS から応答を受信する
まで、呼び出し側プログラムをブロックします。 cclDSync を使用すると、このフロー
を使用する link および status 呼び出しは、即時に呼び出し側プログラムに戻ります。
その後、呼び出し側プログラムは Poll メソッドを使用して、CICS からの応答を後で受
信することができます。
SetTimeout
SetTimeout(Timeout as Integer)
次にフローをアクティブにするときのために、フロー・オブジェクトのタイムアウト値
を設定します。この値はフローがアクティブな間に設定することができますが、現行の
アクティブなフローに影響を与えることはありません。
第 1 章 COM
25
COM クラス: Flow
作成日付: 2005年12月2日
SyncType
SyncType() as Integer
または
SyncType() as CclFlowSyncTypes
使用されている同期タイプを戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
Timeout
Timeout() as Integer
フロー・オブジェクトに対して設定された現行のタイムアウト値を戻します。
Wait
Wait()
サーバーからの応答を待ちます。その間、クライアント処理をブロックします。遅延同
期呼び出しが行われた後、現時点でアプリケーションが同期的な応答を待機しているよ
うな場合に、このメソッドが使用されます。
Map COM クラス
Map COM クラスは、検証を行い、CICS BMS マップから取得したシンボリック情報
を使用して 3270 画面データへのアクセスを提供します。このインターフェースを使用
するには、サーバー・プログラムの BMS マップで、CICSBMSC ユーティリティーを
実行します。
Linux
注: Linux オペレーティング・システムの場合、CICSBMSC は CICS Transaction
Gateway では提供されていません。この機能が必要な場合は、お客様担当の IBM®
サポート担当者にご連絡いただき、ご要望を CICS サービス・チームに伝えるよう
に依頼してください。
Linux の終り
26
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Map
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOMap
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
set var = CreateObject("Ccl.Map")
set var = New CclOMap
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
メソッド
ExCode
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
ExCode() as Integer
または
ExCode() as CclEPIExceptionCodes
現在の条件コードを示す値を戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
FieldByName
FieldByName(name as Integer) as Object
または
第 1 章 COM
27
COM クラス: Map
作成日付: 2005年12月2日
FieldByName(name as Integer) as CclOField
name
必要フィールドのシンボル値。この値は、CICSBMSC ユーティリティーによってソ
ース BMS から生成された <mapname>.BAS ファイルで提供されます。
指定された CclOField オブジェクトを戻します。
Validate
Validate (screenRef as Object, mapname as String) as Boolean
または
Validate (screenRef as CclOScreen, mapname as String) as Boolean
screenRef
CclOScreen オブジェクト
mapname
CICSBMSC ユーティリティーによってソース BMS から生成された
<mapname>.BAS ファイルで提供されるストリング値。
現行の画面に対してマップを検証します。
このメソッドを使用して、特定の BMS マップを CICS サーバーから受け取っているか
どうかを検査することができます。想定される戻り値は以下のとおりです。
TRUE
指定された BMS マップが現行の画面内容と一致しています。
FALSE
指定された BMS マップが現行の画面内容と一致していません。
TRUE が戻された場合は、FieldByName メソッドを使用して、BMS 名でフィールドを
アクセスすることができます。
Screen COM クラス
Screen COM クラスは、3270 仮想画面上のすべてのデータを維持し、このデータへの
アクセスを提供します。これには、現行の 3270 画面上のフィールドを表す一連の
CclOField オブジェクトが入っています。
1 つの画面オブジェクトは、端末が Ccl Terminal 接続またはインストール・メソッド
のいずれかを用いてインストールされている場合に、端末オブジェクトによって作成さ
れます。アプリケーションは、Ccl Terminal Screen メソッドを通じて、CclOScreen オ
ブジェクトにアクセスすることができます。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
28
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Screen
Dim var as Object
Dim var as CclOScreen
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
メソッド
CursorCol
CursorCol() as Integer
現行のカーソルのある列を戻します (左列 = 1)。
CursorRow
CursorRow() as Integer
現行のカーソルのある行を戻します (最上行 = 1)。
Depth
Depth() as Integer
画面上の行数を戻します。
FieldByIndex
FieldByIndex(index as Integer) as Object
または
FieldByIndex(index as Integer) as CclOField
index
必要フィールドの索引番号。最初のフィールドの番号は 1 です。
FieldByPosition
FieldByPosition (rowPos as Integer, colPos as Integer) as Object
または
第 1 章 COM
29
COM クラス: Screen
作成日付: 2005年12月2日
FieldByPosition (rowPos as Integer, colPos as Integer) as CclOField
rowPos
フィールドの行番号 (最上行 = 1)。
colPos
フィールドの列番号 (左端列 = 1)。
FieldCount
FieldCount() as Integer
画面上のフィールド数を戻します。
MapName
MapName() as String
端末リソースで処理された SEND MAP コマンドの MAP オプションで、最近参照され
たマップ名を指定したストリングを戻します。 BMS が端末リソースをサポートしてい
ない場合、あるいは送信されるマップのレコードがサーバーには何もない場合は、戻さ
れる値はブランクです。
MapSetName
MapSetName() as String
端末リソースで処理された SEND MAP コマンドの MAPSET オプションで最近参照さ
れたマップ・セット名を指定したストリングを戻します。最新の要求で MAPSET オプ
ションが指定されなかった場合は、BMS はマップ・セット名としてマップ名を使用し
ました。いずれの場合も、使用されたマップ・セット名には、端末接尾部が付いていた
可能性があります。 BMS が端末リソースをサポートしていない場合、あるいは送信さ
れるマップ・セットのレコードがサーバーには何もない場合は、戻される値はブランク
です。
SetAID
SetAID(key as Integer)
または
SetAID(key as CclADIKeys)
key
213 ページの『CclScreen AID キー・コード』にリストされている AID キー値。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual
Basic Object Browser を使用します。
30
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Screen
次回の送信でサーバーに渡される AID キー値を設定します。
SetCursor
SetCursor (rowPos as Integer, colPos as Integer)
rowPos
必要なカーソルの行番号 (最上行 = 1)。
colPos
必要なカーソルの列番号 (左端列 = 1)。
Width
Width() as Integer
画面上の列数を戻します。
SecAttr COM クラス
SecAttr COM クラスは、verifySecurity または changePassword メソッドを CclOConnect
または CclOTerminal オブジェクトで出すときに、外部セキュリティー・マネージャー
によって報告されるパスワードについての情報を提供します。
このオブジェクトは、CclOConnect または CclOTerminal オブジェクトが作成し、所有
しており、VerifyPassword または ChangePassword メソッドを呼び出すとこのオブジ
ェクトへのアクセスが提供されます。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOSecAttr
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
第 1 章 COM
31
COM クラス: Screen
作成日付: 2005年12月2日
メソッド
ExpiryTime
ExpiryTime() as Object
または
ExpiryTime() as CclOSecTime
パスワードの有効期限が切れる日時を含んだ CclOSecTime オブジェクトを戻します。
InvalidCount
InvalidCount() as Integer
そのユーザー ID に対して入力された無効なパスワードの回数を戻します。
LastAccessTime
LastAccessTime() as Object
または
LastAccessTime() as CclOSecTime
そのユーザー ID が最後にアクセスされた日時を含んだ CclOSecTime オブジェクトを
戻します。
LastVerifiedTime
LastVerifiedTime() as Object
または
LastVerifiedTime() as CclOSecTime
最後の検査が行われた日時を含んだ CclOSecTime オブジェクトを戻します。
SecTime COM クラス
SecTime COM クラスは、接続オブジェクトまたは端末オブジェクトで verifySecurity
または changePassword メソッドを実行する際に外部セキュリティー・マネージャーが
報告するさまざまな項目に対して、CclOSecAttr オブジェクトに日時情報を提供しま
す。
32
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Screen
これらのオブジェクトは、CclOSecAttr オブジェクトが作成し、所有しており、このオ
ブジェクトで使用可能なさまざまなメソッドを通じてそれをアクセスすることができま
す。コンストラクターまたはデストラクターは使用できません。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOSecTime
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
メソッド
Day
unsigned short Day() as Integer
1 から 31 の範囲で日付を戻します。
GetDate
GetDate() as Date
Visual Basic DATE タイプ形式で日時を戻します。
Hours
unsigned short Hours() as Integer
0 から 23 の範囲で時間を戻します。
Hundredths
unsigned short Hundredths() as Integer
0 から 99 の範囲で 100 分の 1 秒単位の時間を戻します。
Minutes
unsigned short Minutes() as Integer
0 から 59 の範囲で分を戻します。
第 1 章 COM
33
COM クラス: Screen
作成日付: 2005年12月2日
Month
unsigned short Month() as Integer
1 から 12 の範囲で月を戻します。
Seconds
unsigned short Seconds() as Integer
0 から 59 の範囲で秒を戻します。
Year
unsigned short Year() as Integer
4 桁の年を戻します。
Session COM クラス
Session COM クラスは、1 つの EPI セッション内における CICS とのデータのフロー
を制御します。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOSession
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
set var = CreateObject("Ccl.Session")
set var = New CclOSession
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
34
CICS Transaction Gateway: プログラミング・リファレンス
COM クラス: Session
作成日付: 2005年12月2日
メソッド
Diagnose
Diagnose() as String
セッションの現行状態のテキスト記述を戻します。
SetSyncType
SetSyncType(syncType as Integer)
または
SetSyncType(syncType as CclFlowSyncTypes)
syncType
この CclOSession オブジェクトに必要な同期タイプ。使用される値は以下のとおり
です。
cclSync
cclDSync
この CclOSession オブジェクトに必要な同期タイプを設定します。 cclSync を使用する
と、このフローを使用する Start および Send 呼び出しは、CICS からの応答を受け取
るまで、呼び出し側プログラムをブロックします。 cclDSync を使用すると、このフロ
ーを使用する Start および Send 呼び出しは、即時に呼び出し側プログラムに戻りま
す。その後、呼び出し側プログラムは Poll メソッドを使用して、CICS からの応答を後
で受け取ることができます。
State
State() as Integer
または
State() as CclEPIStates
セッションの現行状態を示す値を戻します。使用される値は以下のとおりです。
cclActive
接続されています。
cclServer
トランザクションは CICS サーバーで進行中。
cclClient
CICS サーバーは、クライアントからの応答を待機中。
第 1 章 COM
35
COM クラス: Session
作成日付: 2005年12月2日
cclDiscon
切断されています。
cclError
エラー。詳細情報については、ExCode および Diagnose メソッドを呼び出し
てください。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
TransId
TransId() as String
現行トランザクションの 4 文字の名前を戻します。
Terminal COM クラス
Terminal COM クラスは、3270 端末の CICS サーバーへの接続を表しています。
CICS 接続は、Connect メソッドが呼び出されると確立されます。これで、メソッドを
使用して、CICS サーバーの 3270 端末アプリケーション (BMS アプリケーションの場
合が多い) と会話することができます。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOTerminal
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
set var = CreateObject("Ccl.Terminal")
set var = New CclOTerminal
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
36
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Terminal
メソッド
AlterSecurity
AlterSecurity(newUserid as String,newPassword as String)
newPassword
newUserid に指定する新規パスワード。
newUserid
新規のユーザー ID。
ユーザー ID とパスワードを指定せずに構成された端末リソース (サインオン不可端末)
に対して、ユーザー ID とパスワードを再定義することができます。このメソッドは、
端末をインストールする前に呼び出すことができます。このメソッドは端末の定義を変
更します。そのため、インストールを呼び出す場合は、端末に対して新しいユーザー ID
とパスワードを使用する必要があります。
CCSId
CCSId() as long
選択されたコード・ページを示す長形式を戻します。
ChangePassword
ChangePassword (newPassword as String) as Object
または
ChangePassword(newPassword as String) as CclOSecAttr
newPassword
指定する新規パスワード。
端末オブジェクトが持っているパスワードと、端末オブジェクトが持っているユーザー
ID 用に外部セキュリティー・マネージャーが記録しているパスワードを、クライアン
ト・アプリケーションが変更できるようにします。外部セキュリティー・マネージャー
は、端末オブジェクトによって定義されたサーバーにあるものとみなされます。エラー
が生じない場合は、CclOSecAttr オブジェクトが戻されます。
第 1 章 COM
37
COM クラス: Terminal
作成日付: 2005年12月2日
Connect
Connect(servName as String,
devType as String,
nworkName as String)
servName
通信する必要があるサーバー名。ヌル・ストリングが指定された場合は、ゲートウ
ェイ初期設定ファイルで定義されたデフォルトのサーバー・システムが使用されま
す。必要であれば、ブランクの埋め込みによって、名前は 8 文字に拡張されます。
devType
サーバーが端末リソース定義の生成に使用するモデル端末定義の名前。ヌル・スト
リングが指定された場合は、デフォルトのモデルが使用されます。必要であれば、
ブランクの埋め込みによって、名前は 16 文字に拡張されます。
nworkName
インストールまたは予約しておく端末リソースの名前。必要であれば、ブランクの
埋め込みによって、名前は 8 文字に拡張されます。ヌル・ストリングが指定された
場合は、CICS サーバーが名前を割り振ります。
指定された CICS サーバーに対して、3270 通信を確立します。
Devtype
Devtype() as String
端末タイプをストリングとして戻します。
Diagnose
Diagnose() as String
最新のサーバー呼び出しで戻されたエラーの記述を持っている文字ストリングを戻しま
す。
Disconnect
Disconnect()
端末を CICS から切断します。未解決で実行中のトランザクションがあっても、パージ
することはありません。
38
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Terminal
DisconnectWithPurge
DisconnectWithPurge()
端末を CICS から切断し、さらに、未解決で実行中のトランザクションがあればパージ
しようとします。このパージ関数は、端末に対して待機している ATI 要求は取り消し
ません。
DiscReason
DiscReason() as CclEndTermReasons
このメソッドは、端末が切断された理由を示す列挙型を戻します。使用できる値は 212
ページの『CclTerminal EndTermReasons』に示します。
ExCode
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
ExCode() as Integer
または
ExCode() as CclEPIExceptionCodes
サーバーから戻された最新の条件コードを示す値を戻します。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
ExCodeText
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
ExCodeText() as String
サーバーから戻された最新の条件コードを記述するテキスト・ストリングを戻します。
第 1 章 COM
39
COM クラス: Terminal
作成日付: 2005年12月2日
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
Install
Install(session as Object, timeout as Integer)
または
Install(session as CclOSession, timeout as Integer)
session
この端末オブジェクトが使用するセッション・オブジェクト。
InstallTimeout
端末リソースのインストールに許される最大時間を、0 から 3600 の範囲の値の秒
数で示します。 0 の値は、限度を設定しないことを意味します。
このメソッドは、非接続端末リソースをインストールします。端末がすでにインストー
ル済みの場合は、cclInvalidState エラーが生じます。
MakeSecurityDefault
MakeSecurityDefault()
端末オブジェクトの構造で指定されているように、このオブジェクトの現行ユーザー ID
とパスワードが、サーバーに渡される ECI および EPI 要求のデフォルトになることを
クライアントに通知します。
NetName
NetName() as String
端末のネットワーク名を戻します。
Password
Password() as String
端末に関連したユーザー ID の現行パスワードを含むテキスト・ストリングを戻しま
す。パスワードがない場合は、ストリングは空です。
40
CICS Transaction Gateway: プログラミング・リファレンス
COM クラス: Terminal
作成日付: 2005年12月2日
Poll
Poll() as Boolean
遅延同期の Start または Send 要求から応答が受信されたかどうかを調べます。使用さ
れる値は以下のとおりです。
True
未解決の応答はありません。
False
未解決の応答がまだあります。
CICS サーバー・トランザクションは、Terminal.Start または Terminal.Send 呼び出し
に応えて、複数の応答を送信する場合があります。そのため、すべての応答を集めるに
は、複数の Terminal.Poll 呼び出しが必要になることがあります。戻りコードは、さら
にポーリング要求を実行する必要があるかどうかを示しています。
PollForReply
PollForReply() as Boolean
遅延同期の Start 要求または Send 要求から応答が受信されたかどうかを調べます。使
用される値は以下のとおりです。
true
応答が受信されました。
false
応答は受信されませんでした。
CICS サーバー・トランザクションは、Terminal.Start または Terminal.Send 呼び出しに
応えて、複数の応答を送信する場合があります。そのため、すべての応答を集めるに
は、複数の Terminal.PollForReply 呼び出しが必要になることがあります。
Terminal.State メソッドを使用して、応答がまだあるかどうかを調べます。まだある場
合、戻される値は cclServer になります。
QueryATI
QueryATI() as Integer
または
QueryATI() as CclATIStates
自動トランザクション開始 (ATI) が使用可能であるか、使用不可であるかを示す値を戻
します。使用される値は以下のとおりです。
cclATIEnabled
cclATIDisabled
第 1 章 COM
41
COM クラス: Terminal
作成日付: 2005年12月2日
ReadTimeout
ReadTimeout() as Integer
端末の読み取りタイムアウト設定値を戻します。
ReceiveATI
ReceiveATI (session as Object)
または
ReceiveATI (session as CclOSession)
session
CICS サーバー対話で使用される CclOSession オブジェクトへのポインター。
CICS ATI トランザクション用の 3270 データ・ストリームを待機し、受信します。指
定できる CclOSession オブジェクトは同期のみです。
Screen
Screen() as Object
この端末と関連した 3270 画面を処理する CclOScreen オブジェクトを戻します。
Send
Send(session as Object)
または
Send(session as CclOSession)
session
使用されるセッションを制御する CclOSession オブジェクト。 CclOSession オブジ
ェクトを使用しない場合は、ヌルに設定されます。
CclOScreen オブジェクトの現在の内容から、3270 データ・ストリームを生成して、
CICS サーバーに送信します。
ServerName
ServerName() as String
42
CICS Transaction Gateway: プログラミング・リファレンス
COM クラス: Terminal
作成日付: 2005年12月2日
CclOTerminal オブジェクトが持っており、ゲートウェイ初期設定ファイルに示されてい
るサーバー・システムの名前を戻します。あるいは、デフォルト・サーバーが使用され
る予定なのに、まだ呼び出しが行われていない場合はブランクが戻されます。
SetATI
SetATI(stateVal as Integer)
または
SetATI(stateVal as CclATIStates)
stateVal
ATI が使用可能であるか、使用不可であるかを示す値。使用される値は以下のとお
りです。
cclATIEnabled
cclATIDisabled
SetTermDefns
SetTermDefns (servName as String,
devType as String,
nworkName as String
signonCapability as CclSignonTypes
userid as String
password as String
ReadTimeout as Integer
CCSid as Long)
servName
通信する必要があるサーバー名。ヌル・ストリングが指定された場合は、ゲー
トウェイ初期設定ファイルで定義されたデフォルトのサーバー・システムが使
用されます。必要であれば、ブランクの埋め込みによって、名前は 8 文字に拡
張されます。
devType
サーバーが端末リソース定義の生成に使用するモデル端末定義の名前。ヌル・
ストリングが指定された場合は、デフォルトのモデルが使用されます。必要で
あれば、ブランクの埋め込みによって、名前は 16 文字に拡張されます。
nworkName
インストールまたは予約しておく端末リソースの名前。必要であれば、ブラン
クの埋め込みによって、名前は 8 文字に拡張されます。ヌル・ストリングが指
定された場合は、CICS サーバーが名前を割り振ります。
signonCapability
サインオン機能を次のいずれかに設定します。
第 1 章 COM
43
COM クラス: Terminal
作成日付: 2005年12月2日
cclSignonCapable
cclSignonIncapable
ReadTimeout
クラスが clientrepl 状態になる時間とアプリケーション・プログラムが応答メ
ソッドを呼び出す時間との間の最大時間を、0 から 3600 の範囲の値の秒数で
示します。
userid
この端末リソースに関連するユーザー ID の名前。
password
このユーザー ID に関連するパスワード。
CCSid
端末リソースと CICS トランザクション間で受け渡されるデータについて、ク
ライアント・アプリケーションが使用するコード化図形文字セットを識別する
コード化文字セット ID (CCSID) を指定する長形式。ゼロはデフォルトを使用
することを意味します。
端末リソースを作成しますが、サーバーへの接続は行いません。
SignonCapability
SignonCapability() as Integer
または
SignonCapability() as CclSignonTypes
インストールされている端末のタイプを戻します。使用される値は以下のとおりです。
v cclSignonCapable
v cclSignonIncapable
Start
Start (session as Object,
tranCode as String,
startData as String)
または
Start (session as CclOSession,
tranCode as String,
startData as String)
session
使用されるセッションを制御する CclOSession オブジェクト。 CclOSession オブジ
ェクトを使用しない場合は、ヌルに設定されます。
44
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: Terminal
tranCode
開始されるトランザクションの名前。
startData
トランザクション・データを開始します。ヌル値は、開始されるトランザクション
ではデータは不要であることを示しています。
指定されたデータから 3270 データ・ストリームを生成して、指定のトランザクション
を開始する CICS サーバーにそれを送信します。
State
State() as Integer
または
State() as CclEPIStates
セッションの現行状態を示す値を戻します。この値は、Session COM クラスの state メ
ソッドから戻される値と同じです。
タイプ・ライブラリーでは、定数が使用可能です。それを表示するには、Visual Basic
Object Browser を使用します。
TermId
TermId() as String
端末 ID を戻します。
TransId
TransId() as String
現行 CICS トランザクションの 4 文字の名前を戻します。現行のトランザクションか
ら RETURN IMMEDIATE を実行すると、TransId は、新規トランザクションに名前を
与えず、最初のトランザクションの名前をまだ持っていることに注意しください。
Userid
Userid() as String
端末の現行ユーザー ID を含んでいるテキスト・ストリングを戻します。ユーザー ID
がない場合は、ストリングは空です。
第 1 章 COM
45
COM クラス: Terminal
作成日付: 2005年12月2日
VerifyPassword
VerifyPassword() as Object
または
VerifyPassword() as CclOSecAttr
端末オブジェクトが持っているパスワードと、端末オブジェクトが持っているユーザー
ID 用に外部セキュリティー・マネージャーが記録しているパスワードが一致しているか
どうかを、クライアント・アプリケーションが検査できるようにします。外部セキュリ
ティー・マネージャーは、端末オブジェクトによって定義されたサーバーにあるものと
見なされます。エラーが生じない場合は、CclOSecAttr オブジェクトが戻されます。
UOW COM クラス
「作業単位」(UOW) 内でサーバーのリカバリー可能リソースを更新する場合は、この
COM クラスを使用します。 UOW 内のそれぞれの更新は、CclOUOW オブジェクトを
参照すれば確認できます - Connect COM クラス ( 7 ページの『Link』) の Link メソ
ッドを参照してください。
インターフェースの選択
Visual Basic では、次のタイプのインターフェースが使用できます。
Dim var as Object
Dim var as CclOUOW
2 番目のメソッドをお勧めします。
変数を DIM 宣言しない場合は、タイプの指定なしで DIM 宣言します。あるいは
VBScript を使用する場合は、変数のタイプは Object であると見なされます。
オブジェクトの作成
オブジェクトは次の 2 とおりの方法で作成できます。
set var = CreateObject("Ccl.UOW")
set var = New CclOUOW
New は、Visual Basic でお勧めするメソッドです。 VBScript の場合は、CreateObject
メソッドのみが使用できます。
46
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
COM クラス: UOW
メソッド
BackOut
BackOut(flow as Object)
または
BackOut(flow as CclOFlow)
flow
クライアント/サーバー呼び出しを制御するために使用する CclOFlow オブジェク
ト。
この UOW を終了し、サーバーのリカバリー可能リソースに加えられたすべての変更を
バックアウトします。
Commit
Commit(flow as Object)
または
Commit(flow as CclOFlow)
flow
クライアント/サーバー呼び出しを制御するために使用する CclOFlow オブジェク
ト。
この UOW を終了し、サーバーのリカバリー可能リソースに加えられた変更をすべてコ
ミットします。
ForceReset
ForceReset()
この UOW を非アクティブにして、リセットします。 UOW はコミットもバックアウ
トも行われません。
UowId
UowId() as long
UOW の ID を戻します。ゼロの戻りは、UOW が完了しているか、もしくはまだ開始
されていない (言い換えれば非アクティブ) のいずれかであることを示します。
第 1 章 COM
47
COM クラス: UOW
48
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
作成日付: 2005年12月2日
第 2 章 Java
CICS Transaction Gateway で提供される Java クラスとインターフェースに関して、オ
ンラインのプログラミング参照情報が用意されています。
参照情報は HTML 形式であり、JDK で提供される Javadoc ツールを使用して生成され
ます。
参照情報を表示する方法は、次のとおりです。
v Windows の場合、開始メニューで「Programming Reference」のショートカットを選
択する。
v z/OS の場合、バイナリー・モードで FTP を使用して、
<install_path>/docs/javadoc.zip をワークステーションに転送し、unzip する。
v その他のオペレーティング・システムの場合、ご使用の Web ブラウザーで次のファ
イルを開く。
<install_path>/docs/en_US/javadoc/index.html
次のセクションでは、参照情報内で提供される各種の HTML ページについて説明しま
す。
プログラミング参照情報を使用する際には、README ファイルで最新の情報を確認し
てください。
クラス/インターフェースのページ
参照ページには、それぞれのクラスとインターフェースごとに、個別のページがありま
す。これらのページには、それぞれ、次の 3 つのセクションがあります。
1. クラス/インターフェースの記述
v クラス継承ダイアグラム
v 直接のサブクラス
v 既知の全サブインターフェース
v 既知の全インプリメント・クラス
v クラス/インターフェースの宣言
v クラス/インターフェースの記述
2. 要約表
v 内部クラスの要約
v フィールドの要約
© Copyright IBM Corp. 1989, 2005
49
作成日付: 2005年12月2日
v コンストラクターの要約
v メソッドの要約
3. クラス/インターフェースの記述
v フィールドの詳細
v コンストラクターの詳細
v メソッドの詳細
それぞれの要約項目は、その項目の詳細記述の先頭の文を含んでいます。要約項目はア
ルファベット順ですが、詳細記述はソース・コードでの出現順に並んでいます。これに
よって、プログラマーが設定したロジックのグループ化が維持されます。
使用ページ
各文書クラスとインターフェースごとに、それぞれの「使用ページ」があります。この
ページには、どのパッケージ、メソッド、コンストラクター、およびフィールドが、所
定のクラスのどの部分を使用しているかを記述しています。パッケージ A またはイン
ターフェース A の「使用ページ」には以下のことが記載されています。
v A のサブクラス
v A として宣言されるフィールド
v A を戻すメソッド
v タイプ A のパラメーターを用いたメソッドとコンストラクター
このページにアクセスするには、クラスまたはインターフェースに進んで、ナビゲーシ
ョン・バーで「Use」リンクをクリックします。
ツリー (クラス階層)
特定のクラスまたはインターフェースのページを表示しているときに、「 Tree」を選択
すると、CICS Transaction Gateway のクラスとインターフェースの階層が表示されま
す。
索引ページ
索引は、すべてのクラス、インターフェース、コンストラクター、メソッド、およびフ
ィールドのアルファベット順のリストです。
50
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
第 3 章 C++
Ccl クラス
このクラスは、他のクラス (ECI と EPI の両方) が使用する列挙型を定義します。
列挙型
Bool
以下の 2 つの値の等しいペアがあります。
noと yes
off と on
Sync
使用される値は以下のとおりです。
async
非同期
dsync
遅延同期
sync
同期
ExCode
使用される値については、227 ページの表 22 を参照してください。
CclBuf クラス
CclBuf オブジェクトは、情報の保持に使用できるデータ域をメモリー内に持っていま
す。 CclBuf オブジェクト特有の使い方は COMMAREA の保持です。COMMAREA
は、CICS サーバーとの間でデータの受け渡しを行います。
CclBuf オブジェクトは、主にバイト (2 進) データでの使用を対象としています。一般
には、COMMAREA には、CICS サーバーの PL/1 または C プログラムによって作ら
れることが多い、アプリケーション固有のデータ構造が入っています。そのため、
assign() および insert() などのメソッドは、アプリケーションのデータ入力用に void*
パラメーター・タイプを備えています。 SBCS ヌル終了ストリングについては限定され
たサポートがありますが (一部のコード・サンプルではこれを利用している)、CclBuf
クラスには、コード・ページ変換も DBCS サポートもありません。
バッファーの最大データ長は、32 ビット・プラットフォームにおける符号なしの長形
式の最大値 (232) です。 COMMAREA には、CICS による 32 KB の制限がありま
© Copyright IBM Corp. 1989, 2005
51
CclBuf クラス
作成日付: 2005年12月2日
す。これは、CICS Transaction Gateway 初期設定ファイルで MaxBufferSize パラメータ
ーを設定することによって、削減することができます。詳細については、ご使用のオペ
レーティング・システムの「CICS Transaction Gateway: 管理」を参照してください。
COMMAREA として使用するバッファー・オブジェクトが長過ぎる場合は、データ長の
例外が生じます。
CclBuf オブジェクトは作成時に、バッファーとして渡されるメモリー域を使用するか、
もしくは独自にバッファーを割り振ります。このバッファー内のデータの長さは、
CclBuf オブジェクトの作成後に小さくすることができます。このバッファー内のデータ
の長さを元の長さより大きくすることができるのは、CclBuf オブジェクトが fixed では
なく extensible の DataAreaType で作成されている場合に限られます。
バッファー・オブジェクトの DataAreaType が fixed であり、かつメソッドが呼び出さ
れた結果そのデータ域の長さが超過するような場合は、バッファー・オーバーフロー例
外が生じます。例外が処理されない場合は、呼び出しの結果がデータ域の長さに切り捨
てられてバッファーに入ります。
メソッドが呼び出された結果、バッファー・オブジェクトのデータ長がそのデータ域の
長さより小さくなった場合は、データはヌルで埋め込まれます。
メソッドの多くは、オブジェクト参照子を戻します。これによって、ユーザーはメンバ
ー関数に対する呼び出しをチェーニングすることができます。たとえば、
CclBuf comma1;
comma1="Some text";
comma1.insert( 9,"inserted ",5) += " at the end";
というコードは次のようなストリングをもたらします。
Some inserted text at the end
CclBuf コンストラクター
CclBuf (1)
CclBuf(unsigned long length, DataAreaType type = extensible)
length
データ域の最初の長さ (バイト)。デフォルトは 0 です。
type
データ域が拡張可能かどうかを示す列挙型。使用できる値は、extensible または
fixed。デフォルトは extensible。
CclBuf オブジェクトを作成し、与えられた長さでそれ自体のデータ域を割り振ります。
その中のバイトはすべてヌルに設定されます。データ長はゼロに設定され、データがバ
ッファーに入れられるまで、ゼロのままです。
52
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
CclBuf クラス
CclBuf (2)
CclBuf(unsigned long length, void* dataArea)
length
提供されたデータ域の長さ (バイト)。
dataArea
提供されたデータ域の最初のバイトのアドレス。
与えられたデータ域をそれ自体のデータ域として受け入れ、拡張できない CclBuf オブ
ジェクトを作成します。 DataAreaOwner は外部に設定されます。
CclBuf (3)
CclBuf(const char* text, DataAreaType type = extensible)
text
新しい CclBuf オブジェクトにコピーされるストリング。
type
データ域が拡張可能かどうかを示す列挙型。使用できる値は、extensible または
fixed。デフォルトは extensible。
text ストリングと同じ長さでそれ自体のデータ域を割り振って CclBuf オブジェクトを
作成し、ストリングをそのデータ域にコピーします。
CclBuf (4)
CclBuf(const CclBuf& buffer)
buffer
コピーされる CclBuf オブジェクトへの参照。
このコピー・コンストラクターは、所定のオブジェクトのコピーである新しい CclBuf
オブジェクトを作成します。新しいバッファーのデータ長、データ域の長さ、およびデ
ータ域のタイプは、古いバッファーと同じです。新しいバッファーのデータ域の所有者
は、internal です。
public メソッド
assign
CclBuf& assign(unsigned long length, const void* dataArea)
length
ソース・データ域の長さ (バイト)。
dataArea
ソース・データ域のアドレス。
データ域の現在の内容をソース・データで上書きし、データ長をリセットします。
第 3 章 C++
53
CclBuf クラス
作成日付: 2005年12月2日
cut
CclBuf& cut(unsigned long length, unsigned long offset = 0)
length
データ域から切り取られるバイト数。
offset
データ域へのオフセット。デフォルトはゼロです。
データ域から指定されたデータを切り取ります。データ域のデータはヌルで埋め込まれ
ます。
dataArea
const void* dataArea(unsigned long offset = 0) const
offset
データ域へのオフセット。デフォルトはゼロです。
所定のオフセットのアドレスをデータ域へ戻します。
dataAreaLength
unsigned long dataAreaLength() const
データ域の長さ (バイト) を戻します。
dataAreaOwner
DataAreaOwner dataAreaOwner() const
データ域が CclBuf コンストラクターによって割り振られたか、あるいは他から提供さ
れたかを示す列挙型の値を戻します。使用できる値は internal と external です。
dataAreaType
DataAreaType dataAreaType() const
データ域が拡張可能かどうかを示す列挙型の値を戻します。使用できる値は、extensible
および fixed です。
dataLength
unsigned long dataLength() const
データ域のデータの長さを戻します。この長さは、dataAreaLength によって戻される値
を超えることはありません。
54
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
CclBuf クラス
insert
CclBuf& insert(unsigned long length,
const void* dataArea,
unsigned long offset = 0)
length
CclBuf オブジェクトに挿入されるデータの長さ (バイト)。
dataArea
CclBuf オブジェクトに挿入されるソース・データの開始位置。
offset
ストリングが挿入されるデータ域へのオフセット。デフォルトはゼロです。
データ域の指定されたオフセットに、ソース・データを挿入します。
listState
const char* listState() const
オブジェクトの現行状態が入った定様式ストリングを戻します。たとえば、次のとおり
です。
Buffer state..&CclBuf=000489B4 &CclBufI=00203A00
dataLength=8 &dataArea=002039C0
dataAreaLength=8 dataAreaOwner=0 dataAreaType=1
operator= (1)
CclBuf& operator=(const CclBuf& buffer)
buffer
CclBuf オブジェクトへの参照。
別のバッファー・オブジェクトからのデータを割り当てます。
operator= (2)
CclBuf& operator=(const char* text)
text
CclBuf オブジェクトに割り当てられるストリング。
ストリングからデータを割り当てます。
operator+= (1)
CclBuf& operator+=(const CclBuf& buffer)
buffer
CclBuf オブジェクトへの参照。
第 3 章 C++
55
CclBuf クラス
作成日付: 2005年12月2日
別のバッファー・オブジェクトからのデータをデータ域のデータへ付加します。
operator+= (2)
CclBuf& operator+=(const char* text)
text
CclBuf オブジェクトに付加されるストリング。
ストリングをデータ域のデータへ付加します。
operator==
Ccl::Bool operator==(const CclBuf& buffer) const
buffer
CclBuf オブジェクトへの参照。
2 つの CclBuf オブジェクトのバッファーに含まれるデータが同じかどうかを示す列挙
型を戻します。想定される値は、データ長と内容が同じであることを示す yes、または
no です。
operator!=
Ccl::Bool operator!=(const CclBuf& buffer) const
buffer
CclBuf オブジェクトへの参照。
2 つの CclBuf オブジェクトのバッファーに含まれるデータが異なるかどうかを示す列
挙型を戻します。使用できる値は、yes または no です。 no は、データ長が同じで、
内容も同じであることを意味します。
replace
CclBuf& replace(unsigned long length,
const void* dataArea,
unsigned long offset = 0)
length
ソース・データ域の長さ (バイト)。
dataArea
ソース・データ域の開始アドレス。
offset
CclBuf データ域の開始位置に相対的な、新しいデータが書き込まれる位置。デフォ
ルトはゼロです。
指定されたオフセットにある、データ域の現在の内容をソース・データで上書きしま
す。データ長は同じままです。
56
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
CclBuf クラス
setDataLength
unsigned long setDataLength(unsigned long length)
length
データ域の新しい長さ (バイト)。
データ域の現在の長さを変更して、新しい長さを戻します。 CclBuf オブジェクトが
extensible ではない場合、データ域の長さは、データ域の元の長さか length のいずれか
小さい方に設定されます。
length がデータ域の長さより大きい場合、データはヌルで埋め込まれます。
列挙型
DataAreaOwner
CclBuf オブジェクトのデータ域が、オブジェクト外に割り振られたかどうかを示しま
す。使用される値は以下のとおりです。
internal
データ域は CclBuf コンストラクターによって割り振られました。
external
データ域は外部に割り振られました。
DataAreaType
CclBuf オブジェクトのデータ域を、元の長さより大きくできるかどうかを示します。使
用される値は以下のとおりです。
extensible
CclBuf オブジェクトのデータ域を、元の長さより大きくすることができます。
fixed
CclBuf オブジェクトのデータ域を、元の長さより大きくすることはできませ
ん。
CclConn クラス
CclConn クラスのオブジェクトを使用して、クライアントと指定されたサーバー間の
ECI 接続を表します。「CICS Transaction Gateway: プログラミング・ガイド」のサーバ
ーの接続を参照してください。サーバーへのアクセスは、オプションでユーザー ID
とパスワードによって制御されます。このオブジェクトは、サーバーにプログラムを呼
び出したり、接続状態に関する情報を得ることができます。詳細については、「CICS
Transaction Gateway: プログラミング・ガイド」のサーバー・プログラムへのデータの
移動および「CICS Transaction Gateway: プログラミング・ガイド」の可用性のモニタ
ーを参照してください。
第 3 章 C++
57
C++ クラス: CclConn
作成日付: 2005年12月2日
CclConn オブジェクトを作成しても、CICS サーバーとの対話が生じるわけではなく、
サーバーが要求処理できることを保証するわけでもありません。
クライアントとサーバー間のいずれの対話でも、CclFlow オブジェクトを使用する必要
があります。詳細については、「CICS Transaction Gateway プログラミング・ガイド」
のコンパイルおよびリンクを参照してください。
CclConn オブジェクトはコピーすることも、割り当てることもできません。 CclConn
オブジェクトに対してアクティブな CclFlow または CclUOW オブジェクトがあるの
に、その CclConn オブジェクトを削除しようとすると、activeFlow または activeUOW
例外が生じます。
CclConn コンストラクター
CclConn(const char* serverName = 0,
const char* userId = 0,
const char* password = 0,
const char* runTran = 0,
const char* attachTran = 0)
serverName
サーバーの名前。名前が指定されていない場合は、デフォルトのサーバーが使用さ
れます。この名前は、サーバーへの最初の呼び出しの後、serverName メソッドを
使用すれば見つけることができます。必要であれば、ブランクの埋め込みまたは切
り捨てによって、長さは 8 文字に調整されます。
userId
ユーザー ID (必要な場合)。必要であれば、ブランクの埋め込みまたは切り捨てに
よって、長さは 16 文字に調整されます。
password
userID に指定されたユーザー ID に対応するパスワード (必要な場合)。必要であれ
ば、ブランクの埋め込みまたは切り捨てによって、長さは 16 文字に調整されま
す。
runTran
呼び出されたプログラムを実行する CICS トランザクション。デフォルトでは、デ
フォルトのサーバー・トランザクションを使用します。必要であれば、ブランクの
埋め込みまたは切り捨てによって、長さは 4 文字に調整されます。
attachTran
呼び出されたプログラムが付加される CICS トランザクション。デフォルトでは、
デフォルトの CPMI を使用します。必要であれば、ブランクの埋め込みまたは切り
捨てによって、長さは 4 文字に調整されます。
このコンストラクターは CclConn オブジェクトを作成します。作成しても、CICS サー
バーとの対話が生じるわけではなく、サーバーが要求処理できることを保証するわけで
58
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclConn
もありません。接続が状況呼び出しにのみ使用される場合、あるいはサーバーにセキュ
リティーがない場合は、ユーザー ID とパスワードは不要です。
public メソッド
alterSecurity
void alterSecurity(const char* newUserid, const char* newPassword)
newUserid
新規のユーザー ID。
newPassword
新規のユーザー ID に対応する新規パスワード。
次のリンク呼び出しで使用するユーザー ID とパスワードを更新します。
cancel
void cancel(CclFlow& flow)
flow
サーバー要求呼び出しの制御に使用する CclFlow オブジェクトへの参照。
この接続に関連したサーバーに対してそれまでに出された changed 呼び出しをすべて取
り消します。
changed
void changed(CclFlow& flow)
flow
サーバー要求呼び出しの制御に使用する CclFlow オブジェクトへの参照。
現行接続状況が変更になったときに、クライアント・デーモンに通知するようサーバー
に要求します。この接続に対する未解決の changed 呼び出しが既に存在する場合は、そ
の呼び出しは無視されます。サーバーの可用性を確保するには、serverStatus または
serverStatusText を使用してください。
changePassword
CclSecAttr* changePassword(const char* newPassword)
newPassword
指定する新規パスワード。
これによって、クライアント・アプリケーションは次の項目を変更することができま
す。
v 端末オブジェクトが持っているパスワード。
第 3 章 C++
59
C++ クラス: CclConn
作成日付: 2005年12月2日
v 端末オブジェクトが持っているユーザー ID に対して、外部セキュリティー・マネー
ジャーが記録しているパスワード。
外部セキュリティー・マネージャーは、端末オブジェクトによって定義されたサーバー
にあるものと見なされます。
link
void link(CclFlow& flow,
const char* programName,
CclBuf* commarea = 0,
CclUOW* unit = 0)
flow
サーバー要求呼び出しの制御に使用する CclFlow オブジェクトへの参照。
programName
呼び出されたサーバー・プログラムの名前。必要であれば、ブランクの埋め込みま
たは切り捨てによって、長さは 8 文字に調整されます。
commarea
呼び出されたプログラムへ渡すデータを COMMAREA に持っている CclBuf オブ
ジェクトへのポインター。デフォルトでは、COMMAREA を渡しません。
unit
この呼び出しが関連している作業単位 (UOW) を識別する CclUOW オブジェクト
へのポインター。デフォルトはありません。「CICS Transaction Gateway プログラ
ミング・ガイド」の作業論理単位の管理を参照してください。
指定されたプログラムをサーバーで実行することを要求します。サーバー・プログラム
は、着信呼び出しを EXEC CICS LINK 呼び出しと見なします。
commarea バッファー・オブジェクトが長過ぎる場合は、dataLength 例外が生じ、要求
は拒否されます。CICS では、32 KB の制限を設けています。この制限は、CICS
Transaction Gateway 初期設定ファイルの MaxBufferSize パラメーターを使用すれば小さ
くすることができます。
listState
const char* listState() const
オブジェクトの現行状態が入った定様式ストリングを戻します。たとえば、次のとおり
です。
Connection state..&CclConn=000489AC &CclConnI=00203A50
flowCount=0 &CclFlow(changed)=00000000 token(changed)=0
serverName="server " userId="userId
" password="password
&CclUOWI=00000000 runTran="run " attachTran="att "
60
CICS Transaction Gateway: プログラミング・リファレンス
"
C++ クラス: CclConn
作成日付: 2005年12月2日
makeSecurityDefault
void makeSecurityDefault()
接続オブジェクトの構造に指定されているように、このオブジェクトの現行ユーザー ID
とパスワードが、サーバーに渡される ECI および EPI 要求のデフォルトになることを
クライアントに通知します。
password (1)
const char* password() const
CclConn オブジェクトが持っているパスワードを 10 文字までスペースを埋めて戻す
か、あるいはパスワードがない場合はブランクを戻します。
password (2)
void password(Ccl::Bool unpadded)
unpadded
Ccl::Yes
保管されているパスワードのヌル終了ストリングを、ストリングにスペー
スを埋め込まずに戻します。
Ccl::No
ストリングにスペースを埋め込んで戻します - パラメーターなしでパスワ
ード・メソッドを呼び出すのと同じです。
serverName (1)
const char* serverName() const
CclConn オブジェクトが持っているサーバー・システムの名前をスペースで埋めて戻す
か、あるいは、デフォルト・サーバーが使用される予定でも、まだ呼び出しが行われて
いない場合はブランクが戻されます。
serverName (2)
void serverName(Ccl::Bool unpadded)
unpadded
Ccl::Yes
保管されているサーバー名のヌル終了ストリングを、ストリングにスペー
スを埋め込まずに戻します。
Ccl::No
ストリングにスペースを埋め込んで戻します - パラメーターなしで
serverName メソッドを呼び出すのと同じです。
第 3 章 C++
61
C++ クラス: CclConn
作成日付: 2005年12月2日
status
void status(CclFlow& flow)
flow
サーバー要求呼び出しの制御に使用する CclFlow オブジェクトへの参照。
サーバー接続の状況を要求します。応答を受信したならば、serverStatus または
serverStatusText を使用して、サーバーの可用性を取得します。
serverStatus
ServerStatus serverStatus() const
先に実行された status または changed 要求によって設定された、サーバーの使用可能
性を示す列挙型の値を戻します。使用される値は、列挙型のところに示されています。
serverStatusText
const char* serverStatusText() const
先に実行された status または changed 要求によって設定された、サーバーの使用可能
性を示す列挙型のストリングを戻します。
userId (1)
const char* userId() const
CclConn オブジェクトが持っているユーザー ID をスペースで埋めて戻します。ユーザ
ー ID がない場合はブランクを戻します。
userId (2)
void userId(Ccl::Bool unpadded)
unpadded
Ccl::Yes
保管されているユーザー ID のヌル終了ストリングを、ストリングにスペ
ースを埋め込まずに戻します。
Ccl::No
ストリングにスペースを埋め込んで戻します。パラメーターなしでユーザ
ー ID メソッドを呼び出す場合と完全に同じです。
verifyPassword
CclSecAttr* verifyPassword()
62
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclConn
CclConn オブジェクトが持っているパスワードと、CclConn オブジェクトが持っている
ユーザー ID 用に外部セキュリティー・マネージャーが記録しているパスワードが一致
しているかどうかを、クライアント・アプリケーションが検査できるようにします。外
部セキュリティー・マネージャーは、CclConn オブジェクトによって定義されたサーバ
ーにあるものと見なされます。
列挙型
ServerStatus
サーバーの可用性を示します。使用される値は以下のとおりです。
unknown
サーバーの状況は不明です。
available
サーバーは使用可能です。
unavailable
サーバーは使用不可です。
CclECI クラス
存在可能な CclECI クラスのインスタンスは 1 つだけです。これは、instance クラ
ス・メソッドによって作成されます。これは、使用できるサーバーに対するクライアン
トのインターフェースを制御します。
ユーザー独自の handleException メソッドをインプリメントするためには、CclECI をサ
ブクラス化する必要があります。
存在可能な CclECI サブクラスのインスタンスは、1 つだけです。複数のインスタンス
を作成しようとすると、multipleInstance 例外が生じます。
CclECI オブジェクトは、コピーすることも割り当てることもできません。
CclECI コンストラクター (保護)
CclECI()
このコンストラクターは保護されており、サブクラスからのみアクセスできます。
第 3 章 C++
63
C++ クラス: CclECI
作成日付: 2005年12月2日
public メソッド
exCode
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
Ccl::ExCode exCode() const
最新の例外コードを示す列挙型を戻します。使用される値は、227 ページの表 22 にリ
ストされています。
exCodeText
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
const char* exCodeText() const
最新の例外コードを記述するテキスト・ストリングを戻します。
handleException
virtual void handleException(CclException &except)
except
発生したばかりの例外に関する情報が入った CclException オブジェクト。
このメソッドは、例外が発生するたびに呼び出されます。例外を処理するには、CclECI
を常にサブクラス化し、handleException についてユーザー独自のインプリメンテーシ
ョンを用意しておく必要があります。「CICS Transaction Gateway プログラミング・ガ
イド」の例外の処理を参照してください。デフォルトのインプリメンテーションは、
単に例外オブジェクトを throw することです。
instance
static CclECI* instance()
クライアント上に存在する単一の CclECI オブジェクトへのポインターを戻すクラス・
メソッド。以下の例で、その使い方を示します。
64
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclECI
CclECI* pmgr = CclECI::instance();
listState
const char* listState() const
オブジェクトの現行状態が入った定様式ストリングを戻します。たとえば、次のとおり
です。
ECI state..&CclECI=00203AE0 &CclECII=00203B20
retCode=0 exCode=0
serverCount=0 &serverBuffer=00000000
serverCount
unsigned short serverCount() const
CICS Transaction Gateway 初期設定ファイルで構成されているように、CICS Transaction
Gateway が接続可能な使用できるサーバーの数を戻します。実際には、これらのサーバ
ーのうち一部または全部が使用できない場合があります。「CICS Transaction Gateway
プログラミング・ガイド」の可能性のあるサーバーの検索を参照してください。
serverDesc
const char* serverDesc(unsigned short index = 1) const
index
リスト内の接続されたサーバーの索引。デフォルトの索引は、1 です。
index 番目のサーバーの記述を戻します。「CICS Transaction Gateway プログラミン
グ・ガイド」の可能性のあるサーバーの検索を参照してください。
serverName
const char* serverName(unsigned short index = 1) const
index
リスト内の接続されたサーバーの索引。デフォルトの索引は、1 です。
index 番目のサーバーの名前を戻します。「CICS Transaction Gateway プログラミン
グ・ガイド」の可能性のあるサーバーの検索を参照してください。
CclEPI クラス
CclEPI クラスは、CICS Transaction Gateway EPI 関数を初期化して、終了します。ま
た、CICS Transaction Gateway 初期設定ファイルで構成された CICS サーバーに関する
情報を取得できるメソッドも備えています。 CclTerminal オブジェクトを作成して
CICS サーバーに接続する前に、それぞれのアプリケーション・プロセスごとに、この
クラスのオブジェクトを 1 つ作成しておく必要があります。
第 3 章 C++
65
C++ クラス: CclEPI
作成日付: 2005年12月2日
CclEPI コンストラクター
CclEPI()
このメソッドは、クライアントの CICS EPI インターフェースを初期化します。初期化
に失敗すると、initEPI 例外が生じます。 CICS Transaction Gateway EPI の初期化は、
同期的に行われます。言い換えれば、初期化は CclEPI コンストラクターへの呼び出し
が戻ったときに完了します。
public メソッド
diagnose
const char* diagnose() const
最新のサーバー呼び出しで戻された状態の記述が入っている文字ストリングを戻しま
す。
exCode
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
Ccl::ExCode exCode() const
最新の例外コードを示す列挙型を戻します。使用される値は、227 ページの表 22 にリ
ストされています。
exCodeText
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
const char* exCodeText() const
最新の例外コードを記述するテキスト・ストリングを戻します。
66
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclEPI
handleException
virtual void handleException(CclException &except)
except
生じたばかりの例外に関する情報が入った CclException オブジェクト。
このメソッドは、例外が発生するたびに呼び出されます。例外を処理するには、
try...catch を使用するか、 CclEPI をサブクラス化し、handleException についてのユー
ザー独自のインプリメンテーションを用意します。デフォルトのインプリメンテーショ
ンは、単に例外オブジェクトを throw することです。
serverCount
unsigned short serverCount()
CICS Transaction Gateway 初期設定ファイルで構成されているように、CICS Transaction
Gateway が接続可能な使用できるサーバーの数を戻します。
serverDesc
const char* serverDesc(unsigned short index = 1)
index
構成されたサーバーの索引。
選択された CICS サーバーの記述を戻します。あるいは、指定されたサーバーの CICS
Transaction Gateway 初期設定ファイルに情報がない場合はヌルが戻されます。索引が
構成されたサーバーの数を超えると、maxServers 例外が生じます。
serverName
const char* serverName(unsigned short index = 1)
index
構成されたサーバーの索引。
要求された CICS サーバーの名前が戻されます。あるいは、指定されたサーバーの
CICS Transaction Gateway 初期設定ファイルに情報がない場合はヌルが戻されます。索
引が構成されたサーバーの数を超えると、maxServers 例外が生じます。
state
State state() const
EPI の状態を示す列挙型を戻します。使用される値は以下のとおりです。
active
EPI は正常に初期化されました。
第 3 章 C++
67
C++ クラス: CclEPI
作成日付: 2005年12月2日
discon
EPI は終了しました。
error
EPI の初期化は失敗しました。
terminate
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
void terminate()
CICS Transaction Gateway EPI を制御された方法で終了します。 CclEPI オブジェクト
は存在したまま残っているため、アプリケーションは終了中に起こったことをモニター
することができます。
terminate メソッドは CclEPI オブジェクトの消滅中に出されるため、このメソッドを呼
び出す必要はありません。
列挙型
State
EPI の状態を示す列挙型。使用される値は以下のとおりです。
active
EPI は正常に初期化されました。
discon
EPI は終了しました。
error
EPI の初期化は失敗しました。
CclException クラス
CICS Transaction Gateway オブジェクトは、問題を検出すると、CclException クラスの
オブジェクトを構成します。
このような問題を処理するには、CclECI または CclEPI クラスをサブクラス化して、
ユーザー独自の handleException メソッドのインプリメンテーションを行う必要があり
ます。「CICS Transaction Gateway プログラミング・ガイド」の例外の処理を参照し
てください。このメソッドは、CclException オブジェクトのメソッドにアクセスでき、
必要なアクションはすべてとるようにコーディングすることができます。たとえば、プ
ログラムを停止したり、ダイアログ・ボックスを表示することができます。
あるいは、C++ try...catch ブロックを使用して、例外を処理することができます。
68
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclException
CclException オブジェクトは、割り当てることはできません。そのコンストラクター
は、CICS Transaction Gateway クラスのインプリメンテーションのみで使用することを
意図しています。
public メソッド
abendCode
const char* abendCode()
ECI 異常終了コードを含んだヌル終了ストリングを戻すか、あるいは異常終了コードが
ない場合はブランクを戻します。
className
const char* className() const
例外が生じたクラスの名前を戻します。
diagnose
const char* diagnose() const
診断出力で使用する例外を説明したテキストを戻します。たとえば、次のとおりです。
unknown server, classname=CclFlowI, methodName=afterReply, originCode=13
"link", flowId=2, retCode=-22, abendCode="
"
exCode
Ccl::ExCode exCode() const
例外コードを戻します。227 ページの表 22 を参照してください。
exCodeText
const char* exCodeText() const
例外コードを記述したテキスト・ストリングを戻します。
exObject
void* exObject() const
このメソッドは、ECI および EPI の両方に関係しています。
exObject は、例外のときにサーバーとの対話を制御するオブジェクトへのポインターを
戻します。そのようなオブジェクトがない場合は、ヌル・ポインターが戻されます。
第 3 章 C++
69
C++ クラス: CclException
作成日付: 2005年12月2日
v ECI の場合、ポインターは CclFlow* に対して、キャストする必要があります。た
とえば、次のとおりです。
CclFlow* pflo = (CclFlow*) ex.exObject();
v EPI の場合、exObject は例外ブロックで関係のある CclTerminal オブジェクト・ポイ
ンターを戻します。次の例のように、このポインターを CclTerminal* にキャストし
ます。
CclTerminal* pTerm = (CclFlow*)ex.exObject();
methodName
const char* methodName() const
例外が生じたメソッドの名前を戻します。
CclField クラス
CclField クラスのオブジェクトは、3270 画面上の 1 つのフィールドの処理を行いま
す。 CclField オブジェクトは、CICS サーバーからの 3270 データが CclScreen オブジ
ェクトによって処理されるときに作成され、削除されます。
このクラスのメソッドによって、フィールド・テキストおよび属性の読み取りと更新を
行うことができます。変更フィールドは、次回の send で CICS サーバーに送信されま
す。
public メソッド
appendText (1)
void appendText(const char* text, unsigned short length)
text
フィールドに付加されるテキスト。
length
フィールドに付加される文字数。
text からの length 文字を、すでにフィールド内にあるテキストの終わりに付加します。
appendText (2)
void appendText(const char* text)
text
フィールドに付加されるヌル終了テキスト・ストリング。
text ストリング内の文字を、すでにフィールド内にあるテキストの終わりに付加しま
す。
70
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclField
backgroundColor
Color backgroundColor() const
フィールドの背景色を示す列挙型を戻します。使用される値については、このクラスの
説明の終わりにある Color の項目で示します。
baseAttribute
char baseAttribute() const
フィールドの 3270 基本属性を戻します。
column
unsigned short column() const
画面上のフィールドの開始位置の列番号 (左端列が 1 ) を戻します。
dataTag
BaseMDT dataTag() const
フィールド内のデータが変更されたかどうかを示す列挙型を戻します。使用される値は
以下のとおりです。
modified
unmodified
foregroundColor
Color foregroundColor() const
フィールドの前景色を示す列挙型を戻します。使用される値については、このクラスの
説明の終わりにある Color のところに示されています。
highlight
Highlight highlight() const
使用する強調表示のタイプを示す列挙型を戻します。使用される値については、このク
ラスの説明の終わりにある Highlight のところに示されています。
inputProt
BaseProt inputProt() const
第 3 章 C++
71
C++ クラス: CclField
作成日付: 2005年12月2日
フィールドが保護されているかどうかを示す列挙型を戻します。使用される値は以下の
とおりです。
protect
unprotect
inputType
BaseType inputType() const
このフィールドの入力データ・タイプを示す列挙型を戻します。使用される値は以下の
とおりです。
alphanumeric
numeric
intensity
BaseInts intensity() const
フィールドの輝度を示す列挙型を戻します。使用される値は以下のとおりです。
dark
normal
intense
length
unsigned short length() const
フィールドの全長を戻します。これは、3270 属性バイト情報の保管に使用される 1 バ
イトを含んでいます。実際のデータのスペースは、このメソッドにより戻される値より
1 バイト小さくなります。 textLength メソッドも参照してください。
position
unsigned short position() const
画面上のフィールドの開始位置を戻します。位置 = 列番号 + (n x 行番号) で与えられ
ます。ここで、n は行における列の数 (通常は 80) です。
resetDataTag
void resetDataTag()
変更データ・タグ (MDT) を unmodified にリセットします。
72
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclField
row
unsigned short row() const
画面上のフィールドの開始位置の行番号を戻します。最上行が 1 です。
setBaseAttribute
void setBaseAttribute(char attribute)
attribute
フィールドに入力される 3270 基本属性バイトの値。
3270 基本属性を設定します。
setExtAttribute
void setExtAttribute(char attribute, char value)
attribute
設定される拡張属性のタイプ。
value
拡張属性の値。
拡張 3270 属性を設定します。指定された 3270 属性のタイプまたは値が無効な場合
は、parameter 例外が生じます。
setText (1)
これらのメソッドは、指定されたテキストでフィールドを更新します。
void setText(const char* text, unsigned short length)
text
フィールドに入力されるテキスト。
length
フィールドに入力される文字数。
text から length 文字をフィールドにコピーします。
setText (2)
void setText(const char* text)
text
フィールドに入力されるヌル終了テキスト。
text をヌル終了なしで、フィールドにコピーします。
第 3 章 C++
73
C++ クラス: CclField
作成日付: 2005年12月2日
text
const char* text() const
現在フィールドにあるテキストを戻します。
textLength
unsigned short textLength() const
現在フィールドにある文字数を戻します。
transparency
Transparency transparency() const
フィールドの背景透過性を示す列挙型を戻します。使用される値については、このクラ
スの説明の終わりにある Transparency のところに示されています。
列挙型
BaseInts
フィールドの輝度を示します。使用される値は以下のとおりです。
normal
intense
dark
BaseMDT
フィールド内のデータが変更されたかどうかを示します。使用される値は以下のとおり
です。
unmodified
modified
BaseProt
フィールドが保護されているかどうかを示します。使用される値は以下のとおりです。
protect
unprotect
BaseType
フィールドの入力データ・タイプを示します。使用される値は以下のとおりです。
alphanumeric
numeric
74
CICS Transaction Gateway: プログラミング・リファレンス
C++ クラス: CclField
作成日付: 2005年12月2日
Color
使用される値は以下のとおりです。
defaultColor
blue
red
pink
green
cyan
yellow
neutral
black
darkBlue
orange
purple
paleGreen
paleCyan
gray
white
Highlight
使用する強調表示のタイプを示します。使用される値は以下のとおりです。
defaultHlt
normalHlt
blinkHlt
reverseHlt
underscoreHlt
intenseHlt
Transparency
フィールドの背景透過性を示します。使用される値は以下のとおりです。
defaultTran
デフォルトの透過性
orTran
基本カラーとの OR 演算
xorTran
基本カラーとの XOR 演算
opaqueTran
不透明
CclFlow クラス
CclFlow オブジェクトを使用して、クライアント/サーバーのペアの ECI 通信を制御
し、応答処理の同期を判別します。同期の説明については、「CICS Transaction Gateway
プログラミング・ガイド」のコンパイルおよびリンクを参照してください。 CclFlow
は、応答が使用可能なときに、その handleReply を自動的に呼び出します。これによっ
て、インターリーブ応答の制御が単純化されます。ユーザー独自の handleReply メソッ
ドをインプリメントするために、CclFlow をサブクラス化します。
CclFlow オブジェクトは、それぞれのクライアント/サーバーの対話 (クライアントから
の要求とサーバーからの応答) ごとに作成されます。 CclFlow は、非アクティブになる
第 3 章 C++
75
C++ クラス: CclFlow
作成日付: 2005年12月2日
と、すなわち、応答処理が完了すると、再利用することができます。アクティブな
CclFlow オブジェクトを削除または再利用しようとすると、activeFlow 例外が生じま
す。
CclFlow コンストラクター
CclFlow (1)
CclFlow(Ccl::Sync syncType, unsigned long stackPages = 3)
syncType
同期のタイプ。
stackPages
非同期の場合、4kb のスタック・ページ数。デフォルトは 3 です。非同期ではない
場合は、このパラメーターは無視されます。
CclFlow (2)
CclFlow(Ccl::Sync syncType,
unsigned long stackPages,
const unsigned short &timeout)
syncType
同期のタイプ。
stackPages
非同期の場合、4kb のスタック・ページ数。非同期ではない場合は、このパラメー
ターは無視されます。
timeout
ECI プログラムが応答するのを待つ時間 (秒単位)。タイムアウトが生じると、
HandleException メソッドがタイムアウトの CclException オブジェクトを伴って呼
び出されます。有効値は 0 から 32767 です。
public メソッド
abendCode
const char* abendCode() const
最後に実行された CICS トランザクションから異常終了コードを戻します。それがない
場合はブランクを戻します。
callType
CallType callType() const
サーバー要求の最新のタイプを示している列挙型を戻します。
76
CICS Transaction Gateway: プログラミング・リファレンス
C++ クラス: CclFlow
作成日付: 2005年12月2日
callTypeText
const char* callTypeText() const
最新のサーバー要求の名前を戻します。
connection
CclConn* connection() const
使用中のサーバーがある場合はそれを表す CclConn オブジェクトへのポインターを戻し
ます。それがない場合はゼロを戻します。
diagnose
const char* diagnose() const
診断出力で使用する例外を説明したテキストを戻します。たとえば、次のとおりです。
"link", flowId=2, retCode=-22, abendCode="
"
flowId
unsigned short flowId() const
この CclFlow オブジェクトの固有 ID を戻します。
forceReset
void forceReset()
フローを非アクティブにして、リセットします。一般には、フロー・オブジェクトを中
止した後 (たとえば、例外ハンドラーで C++ throw を使用するような場合)、これを使
用して CclFlow オブジェクトの再利用または削除の準備を行います。これは、dsync お
よび async のフローの場合のみ適用されます。別のスレッドからの sync 呼び出しでこ
れを行うことはできません。
handleReply
virtual void handleReply(CclBuf* commarea)
commarea
戻された COMMAREA を含んでいる CclBuf オブジェクトへのポインター。ない
場合はゼロ。
このメソッドは、サーバーから応答を受信するたびに、同期のタイプまたは呼び出しの
タイプに関係なく、呼び出されます。「CICS Transaction Gateway プログラミング・ガ
イド」のコンパイルおよびリンクを参照してください。応答を処理するには、CclFlow
第 3 章 C++
77
C++ クラス: CclFlow
作成日付: 2005年12月2日
をサブクラス化し、handleReply についてユーザー独自のインプリメンテーションを用
意する必要があります。デフォルトのインプリメンテーションでは、単に呼び出し側に
戻すだけです。
listState
const char* listState() const
オブジェクトの現行状態が入った定様式ストリングを戻します。たとえば、次のとおり
です。
Flow state..&CclFlow=000489A4 &CclFlowI=00203B70
syncType=2 threadId=0 stackPages=9 callType=0 flowId=0 commLength=0
retCode=0 systemRC=0 abendCode="
" &CclConnI=00000000 &CclUOWI=00000000
poll
Ccl::Bool poll(CclBuf* commarea = 0)
commarea
戻された COMMAREA を含めるときに使用する CclBuf オブジェクトへのオプシ
ョンのポインター。
遅延同期の Backout、Cancel、Changed、Commit、Link、または Status 呼び出し要求
から、応答を受け取ったかどうかを示している、Ccl クラス内で定義された列挙型を戻
します。遅延同期ではないフロー・オブジェクトで poll を使用すると、syncType 例外
が生じます。使用される値は以下のとおりです。
yes
応答を受信しました。handleReply が同期的に呼び出されました。
no
応答は受信されませんでした。クライアント処理はブロックされません。
setTimeout
void setTimeout(const unsigned short &timeout)
timeout
ECI プログラムが応答するのを待つ時間 (秒単位)。タイムアウトが生じると、
HandleException メソッドがタイムアウトの CclException オブジェクトを伴って呼
び出されます。有効値は 0 から 32767 です。
次にフローをアクティブにするときのために、フロー・オブジェクトのタイムアウト値
を設定します。この値はフローがアクティブな間に設定することができますが、現行の
アクティブなフローには影響しません。
syncType
Ccl::Sync syncType() const
Ccl クラス内で定義された、使用する同期タイプを示す列挙型を戻します。使用できる
値は 51 ページの『Sync』に示します。
78
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclFlow
timeout
short timeout()
フロー・オブジェクトに対して設定された現行のタイムアウト値を取得します。
uow
CclUOW* uow() const
この対話に関連した作業単位 (UOW) の情報を含む CclUOW オブジェクトへのポイン
ターを戻します。
wait
void wait()
サーバーからの応答を待ちます。その間、クライアント処理をブロックします。同期フ
ロー・オブジェクトで wait を使用すると、syncType 例外が生じます。
列挙型
CallType
CclFlow オブジェクトの制御の下で進行中のサーバー要求に対して使用される値は以下
のとおりです。
inactive
現在進行中のサーバー呼び出しはありません。
link
サーバー・プログラムへの CclConn::link 呼び出し。
backout
サーバー上のリカバリー可能リソースに対して行われた変更をバックアウトするため
の CclUOW::backout 呼び出し。
commit
サーバー上のリカバリー可能リソースに対して行われた変更をコミットするための
CclUOW::commit 呼び出し。
status
サーバー接続の状況を判別するための CclConn::status 呼び出し。
changed
サーバーへの接続状況が変更になった場合に通知を要求するための
CclConn::changed 呼び出し。
cancel
以前の CclConn::changed 要求を取り消すための CclConn::cancel 呼び出し。
第 3 章 C++
79
C++ クラス: CclMap
作成日付: 2005年12月2日
CclMap クラス
CclMap クラスは、CICS BMS マップ変換ユーティリティーによって作成されたマップ
の基本クラスです。 CclMap クラスが提供するメソッドは、BMS マップから生成され
たクラスによって継承されます。
CclMap コンストラクター
CclMap(CclScreen* screen)
screen
マッチング CclScreen オブジェクトへのポインター。
CclMap オブジェクトを作成し、そのマップが、CclScreen オブジェクトによって定義さ
れた画面の内容と一致しているか確認 (検証) します。検証が成功しなかった場合は、
invalidMap 例外が生じます。指定された CclScreen オブジェクトが無効な場合は、
parameter 例外が生じます。
public メソッド
exCode
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
Ccl::ExCode exCode() const
最新の例外コードを示す列挙型を戻します。使用される値は、227 ページの表 22 にリ
ストされています。
exCodeText
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
const char* exCodeText() const
最新の例外コードを記述するテキスト・ストリングを戻します。
80
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclMap
field (1)
CclField* field(unsigned short index)
index
必要な CclField オブジェクトの索引番号。
BMS マップの index で識別された CclField オブジェクトへのポインターを戻します。
field (2)
CclField* field(unsigned short row, unsigned short column)
row
マップ内の必要な CclField オブジェクトの行番号。最上行が 1 です。
column
マップ内の必要な CclField オブジェクトの列番号。左端列が 1 です。
BMS マップの位置で識別された CclField オブジェクトへのポインターを戻します。
protected メソッド
namedField
CclField* namedField(unsigned long index)
index
必要な CclField オブジェクトの索引番号。
index 番目のオブジェクトのアドレスを戻します。
validate
void validate(const MapData* map,
const FieldIndex* index,
const FieldData* fields)
map
マップに関する情報を含む構造。構造はこのクラス内で定義され、以下のメンバー
(すべて、符号なしの短整数) を含んでいます。
row
画面上のマップ行位置
col
画面上のマップ列位置
width
列のマップ幅
depth
行のマップの縦の長さ
fields
フィールド数
labels
ラベルの付いたフィールド数
第 3 章 C++
81
C++ クラス: CclMap
作成日付: 2005年12月2日
index
必要な CclField オブジェクトの索引番号。FieldIndex は、このクラスの typedef で
あり、符号なしの短整数と同じです。
fields
特定のフィールドに関する情報を含む構造。構造はこのクラス内で定義され、以下
のメンバー (すべて、符号なしの短整数) を含んでいます。
row
フィールド行 (マップ内)
col
フィールド列 (マップ内)
len
フィールド長
現行の画面に対してマップを検証します。
CclScreen クラス
CclScreen EPI クラスは、3270 仮想画面上のすべてのデータを維持し、このデータへの
アクセスを提供します。これには、現行の 3270 画面上のフィールドを表す一連の
CclField オブジェクトが含まれます。
CclTerminal オブジェクトによって 1 つの CclScreen オブジェクトが作成されます。す
なわち、CclTerminal オブジェクトで screen メソッドを使用すると、このオブジェクト
が得られます。 CICS から 3270 データを受信すると、CclScreen オブジェクトは
CclTerminal オブジェクトによって更新されます。サポートされていないデータ・ストリ
ームを受信した場合は、dataStream 例外を生じます。
public メソッド
cursorCol
unsigned short cursorCol() const
カーソルの現在位置の列番号を戻します。左端列が 1 です。
cursorRow
unsigned short cursorRow() const
カーソルの現在位置の行番号を戻します。最上行が 1 です。
depth
unsigned short depth() const
画面上の行数を戻します。
82
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclScreen
field (1)
このメソッドによって、ポインターを関連する CclField オブジェクトに戻すと、現行画
面上のフィールドをアクセスすることができます。
CclField* field(unsigned short index)
index
対象となるフィールドの索引番号
field (2)
CclField* field(unsigned short row, unsigned short column)
row
フィールドの行番号。
column
フィールドの列番号。
fieldCount
unsigned short fieldCount() const
画面上のフィールド数を戻します。
mapName
const char* mapName()
端末リソースで処理された SEND MAP コマンドの MAP オプションで、最後に参照さ
れたマップ名を指定したストリングを、ヌル終了ストリングで埋め込んで戻します。端
末リソースが BMS でサポートされていない場合、あるいは送信されるマップのレコー
ドがサーバーにない場合は、戻される値はスペースです。
mapSetName
const char* mapSetName()
端末リソースで処理された SEND MAP コマンドの MAP オプションで最後に参照され
たマップ・セット名を指定したストリングを、ヌル終了ストリングで埋め込んで戻しま
す。最新の要求で MAPSET オプションの指定がなかった場合は、BMS はマップ・セ
ット名としてマップ名を使用していました。いずれの場合も、使用されたマップ・セッ
ト名には、端末接尾部が付いていた可能性があります。端末リソースが BMS でサポー
トされていない場合、あるいは送信されるマップ・セットのレコードがサーバーにない
場合は、戻される値はスペースです。
第 3 章 C++
83
C++ クラス: CclScreen
作成日付: 2005年12月2日
setAID
void setAID(const AID key)
key
AID キー。この章の終わりの AID 列挙型を参照してください。
次回の送信でサーバーに渡される AID キー値を設定します。
setCursor
void setCursor(unsigned short row, unsigned short col)
row
カーソルの必要行番号。最上行が 1 です。
col
カーソルの必要列番号。左端列が 1 です。
カーソル位置の設定を要求します。指定された行または列の値が画面の境界外にある場
合は、parameter 例外が生じます。
width
unsigned short width() const
画面上の列数を戻します。
列挙型
AID
AID キーを示します。使用される値は以下のとおりです。
enter
clear
PA1―PA3
PF1―PF24
CclSecAttr
CclSecAttr クラスは、CclConn または CclTerminal オブジェクトで verifyPassword また
は changePassword メソッドを実行したときに外部セキュリティー・マネージャーが報
告するパスワードについての情報を提供します。
このオブジェクトは、CclConn または CclTerminal オブジェクトが作成し、所有してい
ます。verifyPassword または changePassword メソッドを呼び出すと、このオブジェクト
へのアクセスが提供されます。
84
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclScreen
public メソッド
expiryTime
CclSecTime* expiryTime() const
パスワードの有効期限が切れる日時を含んだ CclSecTime オブジェクトを戻します。
invalidCount
unsigned short invalidCount() const
そのユーザー ID に対して入力された無効なパスワードの回数を戻します。
lastAccessTime
CclSecTime* lastAccessTime() const
そのユーザー ID が最後にアクセスされた日時を含んだ CclSecTime オブジェクトを戻
します。
lastVerifiedTime
CclSecTime* lastVerifiedTime() const
最後の検査が行われた日時を含んだ CclSecTime オブジェクトを戻します。
CclSecTime
CclSecTime クラスは、CclConn または CclTerminal オブジェクトで verifyPassword ま
たは changePassword メソッドを実行したときに外部セキュリティー・マネージャーが
報告するさまざまな項目について、CclSecAttr オブジェクトで日時情報を提供します。
このオブジェクトは、CclSecAttr オブジェクトが作成し、所有しており、このオブジェ
クトで使用できるさまざまなメソッドを通じてそれをアクセスすることができます。コ
ンストラクターまたはデストラクターは使用できません。
public メソッド
day
unsigned short day() const
1 から 31 の範囲で日付を戻します。 1 は月の最初の日を表します。
第 3 章 C++
85
C++ クラス: CclScreen
get_time_t
time_t get_time_t() const
time_t 形式で日時を戻します。
get_tm
tm
get_tm() const
tm 構造で日時を戻します。
hours
unsigned short hours() const
0 から 23 の範囲で時間を戻します。
hundredths
unsigned short hundredths() const
0 から 99 の範囲で 100 分の 1 秒を戻します。
minutes
unsigned short minutes() const
0 から 59 の範囲で分を戻します。
month
unsigned short month() const
1 から 12 の範囲で月を戻します。1 月が 1 です。
seconds
unsigned short seconds() const
0 から 59 の範囲で秒を戻します。
year
unsigned short year() const
4 桁の年を戻します。
86
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
作成日付: 2005年12月2日
C++ クラス: CclSession
CclSession クラス
CclSession クラスによって、プログラマーは再使用可能コードをインプリメントして、
3270 会話のセグメント (1 つ以上の送信) を処理することができます。マルチスレッド
環境の場合、このクラスは CICS からの応答を非同期処理します。
CclSession クラスは、1 つの 3270 セッション内での CICS とのデータのフローを制御
します。 CclSession からユーザー独自のクラスを取り出す必要があります。
CclSession コンストラクター
CclSession(Ccl::Sync syncType)
syncType
CICS サーバーへの送信で使用するプロトコル。使用される値は以下のとおりで
す。
async
非同期
dsync
遅延同期
sync
同期
public メソッド
diagnose
const char* diagnose() const
最後のエラーのテキスト記述を戻します。
handleReply
virtual void handleReply(State state, CclScreen* screen)
state
データ・フローの状態を示す列挙型。値の有効範囲は、このクラスの説明の終わり
にある State のところに示されています。
screen
CclScreen オブジェクトへのポインター。
これは、CclSession から取り出すユーザー独自のクラスを開発するときに、オーバーラ
イドできる仮想メソッドです。このメソッドは、データを CICS から受信したときに呼
び出されます。
state
State state() const
第 3 章 C++
87
C++ クラス: CclSession
作成日付: 2005年12月2日
セッションの現行状態を示す列挙型を戻します。使用される値については、このクラス
の説明の終わりにある State のところに示されています。
terminal
CclTerminal* terminal() const
このセッションの CclTerminal オブジェクトへのポインターを戻します。このメソッド
は、CclSession オブジェクトが CclTerminal オブジェクトに関連付けられるまで (すな
わち、CclSession オブジェクトが CclTerminal send メソッドのパラメーターとして使用
されるまで)、ヌル・ポインターを戻します。
transID
const char* transID() const
現行トランザクションの 4 文字の名前を戻します。
列挙型
State
セッションの状態を示します。使用される値は以下のとおりです。
idle
端末は接続されており、進行中の CICS トランザクションはありません。
server
CICS トランザクションがサーバーで進行中。
client
CICS トランザクションが進行中で、サーバーはクライアントからの応答を待機中。
discon
端末は切断されています。
error
端末にエラーがあります。
CclTerminal クラス
CclTerminal クラスのオブジェクトは、3270 端末から CICS サーバーへの接続を表し
ています。 CICS 接続は、オブジェクトを作成したときに確立されます。これによっ
て、メソッドを使用して、CICS サーバーの 3270 端末アプリケーション (BMS アプリ
ケーションの場合が多い) と会話することができるようになります。
CclTerminal を作成するには、EPI を初期化 (すなわち、CclEPI オブジェクトの作成)
しておく必要があります。
88
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclTerminal
CclTerminal クラスのデストラクターは、端末に対して待機している ATI 要求をパージ
することはありません。
CclTerminal コンストラクター
CclTerminal (1)
CclTerminal(const char* server = NULL,
const char* devtype = NULL,
const char* netname = NULL)
server
通信する必要があるサーバー名。名前が指定されていない場合は、デフォルトのサ
ーバー・システムと見なされます。長さは、ブランクの埋め込みによって、8 文字
に調整されます。
devtype
サーバーが端末リソース定義の生成に使用するモデル端末定義の名前。ストリング
が指定されていない場合は、デフォルトのモデルが使用されます。長さは、ブラン
クの埋め込みによって、16 文字に調整されます。
netname
インストールまたは予約しておく端末リソースの名前。デフォルトでは、devtype の
内容を使用します。長さは、ブランクの埋め込みによって、8 文字に調整されま
す。
クライアントとサーバー間の EPI 通信に使用する CclTerminal オブジェクトを作成しま
す。
このコンストラクターは、暗黙的に端末のインストールを行います。この方法で端末オ
ブジェクトを構成する場合は、インストール・メソッドを呼び出す必要はありません。
指定されたサーバーが CICS Transaction Gateway 初期設定ファイルで構成されていない
場合は、unknownServer 例外が生じます。
server、devtype または netname に無効な値が指定された場合は、parameter 例外が生じ
ます。
CclEPI が作成されていない場合は、initEPI 例外が生じます。
サポートされる端末接続の数が最大数を超えた場合は、maxRequests 例外が生じます。
CclTerminal (2)
CclTerminal(const char* server,
const char* devtype,
const char* netname,
signonType signonCapability
第 3 章 C++
89
C++ クラス: CclTerminal
作成日付: 2005年12月2日
const
const
const
const
char* userid
char* password
unsigned short &readTimeOut,
unsigned short &CCSid)
server
通信する必要があるサーバー名。名前が指定されていない場合は、デフォルトのサ
ーバー・システムと見なされます。長さは、ブランクの埋め込みによって、8 文字
に調整されます。
devtype
サーバーが端末リソース定義の生成に使用するモデル端末定義の名前。ストリング
が指定されていない場合は、デフォルトのモデルが使用されます。長さは、ブラン
クの埋め込みによって、16 文字に調整されます。
netname
インストールまたは予約しておく端末リソースの名前。デフォルトでは、devtype の
内容を使用します。長さは、ブランクの埋め込みによって、8 文字に調整されま
す。
signonCapability
端末のサインオン機能のタイプを設定します。
使用される値は以下のとおりです。
CclTerminal::SignonCapable
CclTerminal::SignonIncapable
userid
この端末リソースに関連するユーザー ID の名前。
password
このユーザー ID に関連するパスワード。
readTimeOut
クラスが clientrepl 状態になる時間とアプリケーション・プログラムが応答メソッ
ドを呼び出す時間との間の最大時間を、0 から 3600 の範囲の値の秒数で示しま
す。
CCSid
端末リソースと CICS トランザクション間で受け渡されるデータについて、クライ
アント・アプリケーションが使用するコード化図形文字セットを識別するコード化
文字セット ID (CCSID) を指定する符号なしの短形式。ゼロ・ストリングはデフォ
ルトを使用することを意味します。
暗黙的な端末インストールを行わない端末オブジェクトを作成します。端末をインスト
ールするには、インストール・メソッドを実行する必要があります。
90
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclTerminal
public メソッド
alterSecurity
void alterSecurity(const char* userid,const char* password)
userid
新規のユーザー ID。
password
userid の新規パスワード。
端末リソースに対して、ユーザー ID とパスワードを再定義できるようにします。この
メソッドは、端末をインストールする前に呼び出すことができます。このメソッドは端
末の定義のみを変更します。したがって、インストールを呼び出す場合は、端末に対し
て新しいユーザー ID とパスワードを使用することになります。
changePassword
CclSecAttr* changePassword(const char* newPassword)
newPassword
新規パスワード
端末オブジェクトが持っているパスワードと、端末オブジェクトが持っているユーザー
ID 用に外部セキュリティー・マネージャーが記録しているパスワードを、クライアン
ト・アプリケーションが変更できるようにします。外部セキュリティー・マネージャー
は、端末オブジェクトによって定義されたサーバーにあるものと見なされます。
CCSid
unsigned short CCSid()
選択されたコード・ページを符号なしの短形式として戻します。
diagnose
const char* diagnose()
最新のサーバー呼び出しで戻されたエラーの記述を持っている文字ストリングを戻しま
す。
disconnect (1)
void disconnect()
端末を CICS から切断します。未解決で実行中のトランザクションがあっても、パージ
することはありません。
第 3 章 C++
91
C++ クラス: CclTerminal
作成日付: 2005年12月2日
disconnect (2)
void disconnect(Ccl::Bool withPurge)
withPurge
Ccl::Yes
端末を CICS から切断し、さらに、未解決で実行中のトランザクションが
あればパージしようとします。このパージ関数は、端末に対して待機して
いる ATI 要求は取り消しません。
Ccl::No 端末を CICS から切断します。未解決で実行中のトランザクションをパー
ジすることはありません。
discReason
void discReason(void)
切断の理由を戻します。 98 ページの『EndTerminalReason』を参照してください。
exCode
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
Ccl::ExCode exCode() const
最新の例外コードを示す列挙型を戻します。使用される値は、227 ページの表 22 にリ
ストされています。
exCodeText
使用すべきでないメソッド
このメソッドは新規アプリケーションでは使用しないでください。このメソッド
は推奨されません。ここでは互換性を保つ目的でのみ例示します。
const char* exCodeText() const
最新の例外コードを記述するテキスト・ストリングを戻します。
92
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclTerminal
install
void install(CclSession *session,
const unsigned short &installTimeOut)
session
CICS サーバー対話で使用される CclSession オブジェクトへのポインター。
installTimeOut
端末リソースのインストールに許される最大時間を、0 から 3600 の範囲の値の秒
数で示します。 0 の値は、限度を設定しないことを意味します。
このメソッドは、非接続端末リソースを接続します。すでに接続済みの場合は
invalidState エラーが、あるいはタイムアウトが起こった場合はタイムアウト・エラーが
throw されます。
makeSecurityDefault
void makeSecurityDefault()
端末オブジェクトの構造で指定されているように、このオブジェクトの現行ユーザー ID
とパスワードが、サーバーに渡される ECI および EPI 要求のデフォルトになることを
クライアントに通知します。
netName
const char* netName() const
端末のネットワーク名をヌル終了ストリングとして戻します。
password
const char* password()
その端末の現行のパスワード設定値を含むヌル終了ストリングを戻します。あるいは、
端末にパスワードがない場合はヌルを戻します。
poll
Ccl::Bool poll()
CICS サーバーからのデータをポーリングします。
遅延同期伝送の場合 (すなわち、前回の送信呼び出しで遅延同期 CclSession オブジェク
トが使用された場合)、アプリケーションは、CICS サーバーからデータを受信する必要
があるときに poll メソッドを呼び出します。 CICS からの応答が作動可能な場合、
CclTerminal オブジェクトが CICS から受信した 3270 データ・ストリームの内容で
第 3 章 C++
93
C++ クラス: CclTerminal
作成日付: 2005年12月2日
CclScreen オブジェクトを更新し、CclSession オブジェクトの handleReply 仮想関数が
呼び出され、さらに poll メソッドが Ccl::yes を戻します。 CICS からの応答が受信
されなかった場合は、poll メソッドは Ccl::no を戻します。
poll メソッドは、遅延同期伝送の場合にのみ使用されます。そのため、同期または非同
期セッションの使用中にこのポーリング・メソッドが呼び出されると、syncType 例外が
生じます。それ以前に send 呼び出しがなかった場合に、poll メソッドが呼び出される
と、invalidState 例外が生じます。ポーリングを呼び出すためには、CclTerminal オブジ
ェクトが server 状態にある必要があります。
CICS サーバー・トランザクションは、CclTerminal send 呼び出しに応えて、複数の応
答を送信する場合があります。そのため、すべての応答を集めるには、複数の poll 呼
び出しが必要になることがあります。応答がまだあるかどうかを調べるには、
CclTerminal state メソッドを使用します。ある場合は、戻される値は server です。
「CICS Transaction Gateway プログラミング・ガイド」の EPI 呼び出しの同期タイプ
を参照してください。
queryATI
ATIState queryATI()
「自動トランザクション開始 (ATI)」が使用可能であるか、使用不可であるかを示す列
挙型を戻します。使用される値は以下のとおりです。
disabled
enabled
readTimeout
const char* readTimeout()
端末の読み取りタイムアウト値をヌル終了ストリングとして戻します。
receiveATI
void receiveATI(CclSession* session)
session
CICS サーバー対話で使用される CclSession オブジェクトへのポインター。
CICS ATI トランザクションの 3270 データ・ストリームを待ち、それを受信します。
パラメーターとして指定された CclSession オブジェクトは、呼び出しが同期か非同期
かを判別し、さらに応答ハンドラーを提供するためにサブクラス化することができま
す。
94
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclTerminal
screen
CclScreen* screen() const
この端末セッションと関連した 3270 画面を処理する CclScreen オブジェクトへのポイ
ンターを戻します。
send (1)
void send(CclSession* session,
const char* transid,
const char* startdata = NULL)
session
使用するセッションを制御する CclSession オブジェクトへのポインター。指定され
た CclSession オブジェクトが無効な場合は、parameter 例外が生じます。
transid
開始するトランザクションの名前。
startdata
トランザクション・データを開始します。デフォルトでは、開始するトランザクシ
ョンのデータはありません。
指定されたトランザクションを開始して、3270 データ・ストリームをフォーマット設定
し、送信します。 CclTerminal オブジェクトは idle 状態 (CICS サーバーに接続されて
いるが、進行中のトランザクションはない) でなければなりません。オブジェクトが
idle 状態にない場合は、invalidState 例外が生じます。
send (2)
void send(CclSession* session)
session パラメーターについては、上記のとおりです。
3270 データ・ストリームをフォーマット設定して、送信します。 CclTerminal オブジェ
クトは idle 状態 (上記を参照)、または client 状態 (すなわち、トランザクションが進
行中であり、CICS サーバーは応答待ち) でなければなりません。オブジェクトが idle
または client 状態にない場合は、invalidState 例外が生じます。
setATI
void setATI(ATIState newstate)
newstate
ATI が使用可能であるか、使用不可であるかを示す列挙型。値の有効範囲は、この
クラス内であり、使用される値は disabled と enabled です。
第 3 章 C++
95
C++ クラス: CclTerminal
作成日付: 2005年12月2日
signonCapability
signonType signonCapability()
インストール時に端末に適用されるサインオン機能のタイプを戻します。
使用される値は以下のとおりです。
CclTerminal::signonCapable
CclTerminal::signonIncapable
CclTerminal::signonUnknown
state
State state() const
セッションの現行状態を示す列挙型を戻します。使用される値については、このクラス
の説明の終わりに示します。
serverName
const char* serverName() const
この端末セッションが接続される CICS サーバーの名前を戻します。
termID
const char* termID() const
4 文字の端末 ID を戻します。
transID
const char* transID() const
現行 CICS トランザクションの 4 文字の名前を戻します。現行のトランザクションか
ら、RETURN IMMEDIATE を実行すると、TransId は、新規トランザクションの名前を
提供しません。つまり、まだ最初のトランザクションの名前を持っています。
userId
const char* userId()
端末の現行のユーザー ID 設定値を含むヌル終了ストリングを戻します。ない場合はヌ
ルを戻します。
96
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclTerminal
verifyPassword
CclSecAttr* verifyPassword()
端末オブジェクトが持っているパスワードと、端末オブジェクトが持っているユーザー
ID 用に外部セキュリティー・マネージャーが記録しているパスワードが一致しているか
どうかを、クライアント・アプリケーションが検査できるようにします。外部セキュリ
ティー・マネージャーは、端末オブジェクトによって定義されたサーバーにあるものと
見なされます。
列挙型
ATIState
「自動トランザクション開始 (ATI)」が使用可能であるか、使用不可であるかを示しま
す。使用される値は以下のとおりです。
enabled
disabled
signonType
端末のサインオン機能を示します。使用される値は以下のとおりです。
signonCapable
サインオン可能
signonIncapable
サインオン不可能
signonUnknown
サインオン不明
State
CclTerminal オブジェクトの状態を示します。使用される値は以下のとおりです。
client
CICS トランザクションが進行中であり、サーバーはクライアントからの応答を待機
中。
discon
端末は切断されています。
error
端末にエラーがあります。
idle
端末は接続されており、進行中の CICS トランザクションはありません。
server
CICS トランザクションがサーバーで進行中。
第 3 章 C++
97
C++ クラス: CclTerminal
作成日付: 2005年12月2日
termDefined
端末は定義されていますが、まだインストールされていません。
txnTimedOut
会話型トランザクションがタイムアウトになりましたが、END_TRAN イベントがま
だ取得されていません。同期および非同期端末の場合、このイベントが受信され、端
末がアイドル状態になるまで、端末メソッドはブロックされます。遅延同期端末の場
合は、poll() を実行してこのイベントを取得する必要があることを示しています。こ
れによって端末はアイドル状態にリセットされます。 handleException() および
handleReply() は呼び出されません。
EndTerminalReason
CclTerminal オブジェクトの EndTerminalReason を示します。使用される値は以下のと
おりです。
signoff
切断が要求されました。あるいはユーザーが端末をサインオフしました。
shutdown
CICS サーバーがシャットダウンされました。
outofService
端末はサービス休止に切り替えられました。
unknown
不明な状態が発生しました。
failed
端末の切断に失敗しました。
notDiscon
端末は切断されていません。
CclUOW クラス
「作業単位」(UOW) 内でサーバーのリカバリー可能リソースを更新する場合は、この
ECI クラスを使用します。 UOW 内のそれぞれの更新は、その CclUOW を参照するこ
とによりクライアントで識別されます - CclConn の link ( 60 ページの『link』) を参照
してください。
CclUOW オブジェクトはコピーすることも、割り当てることもできません。アクティブ
な CclFlow オブジェクトがある CclUOW オブジェクトを削除しようとすると、
activeFlow 例外が生じます。アクティブな CclUOW オブジェクト (すなわち、コミット
もバックアウトもされていないオブジェクト) を削除しようとすると、activeUOW 例外
が生じます。
98
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
C++ クラス: CclUOW
CclUOW コンストラクター
CclUOW()
CclUOW オブジェクトを作成します。
public メソッド
backout
void backout(CclFlow& flow)
flow
クライアント/サーバー呼び出しを制御するために使用する CclFlow オブジェクト
への参照。
この UOW を終了して、サーバーのリカバリー可能リソースに加えられたすべての変更
をバックアウトします。
commit
void commit(CclFlow& flow)
flow
クライアント/サーバー呼び出しを制御するために使用する CclFlow オブジェクト
への参照。
この UOW を終了して、サーバーのリカバリー可能リソースに加えられた変更をすべて
コミットします。
forceReset
void forceReset()
この UOW を非アクティブにして、リセットします。
listState
const char* listState() const
オブジェクトの現行状態が入っている、ゼロ終了の定様式ストリングを戻します。たと
えば、次のとおりです。
UOW state..&CclUOW=0004899C &CclUOWI=00203BD0
&CclConnI=00000000 uowId=0 &CclFlowI=00000000
uowId
unsigned long uowId() const
第 3 章 C++
99
C++ クラス: CclUOW
作成日付: 2005年12月2日
UOW の ID を戻します。 0 は、UOW が完了しているか、またはまだ開始されていな
い、のいずれかを意味します。言い換えれば、非アクティブということです。
100
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
第 4 章 C および COBOL
外部呼び出しインターフェース
CICS_ExternalCall ECI_Parms
目的
CICS_ExternalCall は、プログラム・リンク呼び出し、状況情報呼び出し、および応答
請求呼び出しへのアクセスを与えます。実行する関数は、ECI パラメーター・ブロック
の eci_call_type フィールドで制御されます。
パラメーター
ECI_Parms
ECI パラメーター・ブロックへのポインター。使用前に、パラメーター・ブロ
ックをヌルに設定します。入出力として使用されるパラメーター・ブロック・
フィールドについては、それぞれの呼び出しタイプごとに、次のセクションで
詳しく説明します。フィールドの概要は以下のとおりです。
eci_call_type
行われる呼び出しのタイプを定義する整数フィールド。提供される関
数の詳細については、「CICS Transaction Gateway: プログラミング・
ガイド」の ECI 呼び出しのタイプを参照してください。
eci_program_name
呼び出されるプログラムの名前。
eci_userid
セキュリティー検査用のユーザー ID。
eci_password
セキュリティー検査用のパスワード。
eci_transid
トランザクション ID。
eci_abend_code
失敗したプログラムの異常終了コード。
eci_commarea
呼び出されたプログラム、または戻される状況情報で使用する
COMMAREA。
© Copyright IBM Corp. 1989, 2005
101
作成日付: 2005年12月2日
eci_commarea_length
COMMAREA の長さ。 COMMAREA のサイズは、入力または出力デ
ータの最大サイズに設定する必要があります。この長さは、32 500 バ
イトを超えてはなりません。入力データが COMMAREA の長さより
小さい場合は、COMMAREA をヌルで埋め込みます。クライアント・
デーモンは、このヌルの埋め込みを除去し、ECI 要求のデータのみを
CICS サーバーに送信します。
eci_timeout
CICS サーバーからの応答を待つ時間。ECI タイムアウト・サポート
の詳細については、「CICS Transaction Gateway: プログラミング・ガ
イド」を参照してください。
reserved1
予期しないエラーに関する詳細情報を与える戻りコード。
このフィールドは、以前は eci_system_ return_code でした。本製品
のバージョン 3.1 以降、このフィールドは互換性のために保持されて
います。このフィールドに戻される情報はありません。システム・エ
ラーはすべて、CICS Transaction Gateway のエラー・ログに書き込ま
れます。
eci_extend_mode
複数の ECI 要求にまたがる作業論理単位を管理するために使用しま
す。詳細については、「CICS Transaction Gateway: プログラミング・
ガイド」を参照してください。
eci_message_qualifier
ユーザーが提供する、非同期呼び出しへの参照。
eci_luw_token
作業論理単位の ID。
eci_sysid
将来の利用のため予約済みです。ヌルのままにしておきます。
eci_version
アプリケーションのコーディングに対応する ECI のバージョン。
ECI_VERSION_1A の値を使用します。
eci_system_name
CICS サーバーの名前。
eci_callback
非同期要求のコールバック・ルーチンへのポインター。
eci_userid2
セキュリティー検査用のユーザー ID。これは、ユーザー ID または
パスワードが 8 文字を超える場合に使用します。
102
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
eci_password2
セキュリティー検査用のパスワード。これは、ユーザー ID またはパ
スワードが 8 文字を超える場合に使用します。
eci_tpn
ミラー・トランザクションのトランザクション ID。
戻りコード
次のセクションで説明するそれぞれの呼び出しタイプごとの戻りコードの他に、以下の
戻りコードがあります。
ECI_ERR_INVALID_CALL_TYPE
呼び出しタイプが有効な呼び出しタイプの 1 つではありませんでした。
ECI_ERR_CALL_FROM_CALLBACK
呼び出しがコールバック・ルーチンから行われました。
ECI_ERR_REQUEST_TIMEOUT
要求を処理する前にタイムアウト・インターバルの期限が切れたか、または指
定されたインターバルがマイナスです。
ECI_ERR_RESPONSE_TIMEOUT
プログラムの実行中にタイムアウト・インターバルの期限が切れました。
ECI_ERR_SYSTEM_ERROR
内部システム・エラーが発生しました。 CICS Transaction Gateway またはサー
バーでエラーが起こった可能性があります。 CICS Transaction Gateway のエラ
ー・ログに戻された情報はサービス担当員が診断する際に役立つため、プログ
ラマーはこの情報を保管しておく必要があります。
ECI_ERR_INVALID_VERSION
eci_version に指定された値が無効です。
インプリメンテーションによっては、上記の一部の戻りコードおよびそれぞれの呼び出
しタイプごとの戻りコードが戻されないことがあります。
Windows オペレーティング・システムの場合、実際の戻りコード値をシンボル名にマッ
ピングしたものが、次のファイルに含まれています。
C
<install_path>\include\cics_eci.h
Cobol
<install_path>\copybook\cicseci.cbl
UNIX および Linux オペレーティング・システムの場合は、次のファイルです。
C
<install_path>/include/cics_eci.h
第 4 章 C および COBOL
103
作成日付: 2005年12月2日
CICS_ExternalCall の呼び出しタイプ
ECI_SYNC 呼び出しタイプ
環境: ECI_SYNC 呼び出しタイプは、あらゆる環境で使用できます。
目的: ECI_SYNC 呼び出しタイプは、作業論理単位を開始、継続、または終了するた
めの同期プログラム・リンク呼び出しを提供します。呼び出された CICS プログラムの
実行が完了するまで、呼び出し側のアプリケーションに制御は戻りません。
ECI パラメーター・ブロック・フィールド: ECI パラメーター・ブロックは、入
力パラメーター・フィールドを設定する前に、ヌルに設定しておく必要があります。
eci_call_type
必須の入力パラメーターであり、ECI_SYNC に設定する必要があります。
eci_program_name
入力パラメーター。eci_extend_mode が ECI_COMMIT または ECI_BACKOUT
以外の場合は必須です。 (詳細については、「CICS Transaction Gateway: プロ
グラミング・ガイド」の ECI における作業論理単位の表を参照してくださ
い。)
呼び出されるプログラムの名前を含む 8 文字のフィールドです。使用してい
ない文字部分はスペースで埋めてください。このフィールドは、大文字に変換
されずにサーバーへ送信されます。
使用される文字は、クライアントのコード・ページから EBCDIC コード・ペ
ージへ、送信する前に変換されます。サーバーが ASCII コード・ページを使
用している場合は、文字は再変換されます。この変換において不変であること
が保証されている文字は、大文字の A から Z と数字の 0 から 9 だけです。
一部の EBCDIC サーバー (カタカナおよびヘブライ語文字セット A) では、英
小文字の標準表記を使用していません。したがって、そのようなサーバーとの
通信では、英小文字の使用には注意してください。
eci_userid
必須の入力パラメーター。
ユーザー ID の入った 8 文字のフィールドです。使用していない文字部分はス
ペースで埋めてください。
CICS Transaction Gateway およびサーバーの資料を調べて、このフィールドが
サーバーに送信される前に大文字に変換されるかどうかを確認してください。
8 文字より長いユーザー ID またはパスワードが必要な場合は、eci_userid お
よび eci_password をヌルに設定し、代わりにフィールド eci_userid2 および
eci_password2 を使用してください。
104
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
ユーザー ID が指定された場合、サーバーはユーザー ID、およびパスワード
が指定されている場合はパスワードも使用して、ユーザーの認証を行います。
指定されたユーザー ID とパスワードは、これ以降、サーバーでのセキュリテ
ィー検査に使用されます。
eci_password
必須の入力パラメーター。
パスワードの入った 8 文字のフィールドです。使用していない文字部分はスペ
ースで埋めてください。
CICS Transaction Gateway およびサーバーの資料を調べて、このフィールドが
サーバーに送信される前に大文字に変換されるかどうかを確認してください。
8 文字より長いユーザー ID またはパスワードが必要な場合はこのフィールド
と eci_password をヌルに設定し、代わりにフィールド eci_userid2 および
eci_password2 を使用してください。
eci_transid
オプションの入力パラメーター。
オプションで CICS トランザクションの入っている 4 文字のフィールドで
す。使用していない文字部分はスペースで埋めてください。 eci_tpn (ヌル以外
の任意の値に設定されている) を使用する場合は、このパラメーターは無視さ
れます。このパラメーターの用途は、要求を送信するクライアントによって異
なります。 eci_transid の値は、大文字変換なしで ASCII から EBCDIC に変
換され、eci_program_name で指定されているプログラムへの LINK の間は
EIBTRNID に保管されます。
呼び出されたプログラムはミラー・トランザクション CPMI のもとで実行され
ますが、eci_transid トランザクション名のもとでリンクされます。この名前
は、呼び出されたプログラムがトランザクション ID を照会する際に使用でき
ます。サーバーによっては、トランザクション ID を使用して、呼び出された
プログラムのセキュリティー属性とパフォーマンス属性を判別する場合があり
ます。このようなサーバーでは、呼び出されたプログラムの処理を制御するの
に、このパラメーターを使用することをお勧めします。
ECI 要求を拡張する (eci_extend_mode の説明を参照) 場合は、eci_transid パ
ラメーターは、作業単位の最初の呼び出しに対してのみ意味を持ちます。
このフィールドがすべてヌルで、eci_tpn が指定されていない場合は、デフォ
ルトのサーバー・トランザクション ID が使用されます。
eci_abend_code
出力パラメーター。
呼び出されたプログラムを実行するトランザクションが異常終了した場合に、
CICS 異常終了コードが戻される 4 文字のフィールドです。使用していない文
字部分はスペースで埋められます。
第 4 章 C および COBOL
105
作成日付: 2005年12月2日
eci_commarea
オプションの入力パラメーター。
呼び出された CICS プログラムに、その COMMAREA として渡されるデータ
へのポインター。 COMMAREA は、呼び出されたプログラムが使用し、アプ
リケーションに情報を戻します。
COMMAREA が不要な場合は、ヌル・ポインターを指定し、長さ
(eci_commarea_length で指定) をゼロに設定します。
アプリケーションのコード・ページがサーバーのコード・ページと異なる場合
は、サーバーでデータ変換を行う必要があります。これを行うには、DFHCNV
マクロ定義などの CICS 提供のリソース変換機能を使用します。
eci_commarea_length
オプションの入力パラメーター。
COMMAREA の長さをバイトで表します。この値は、32 500 を超えてはなり
ません。 (クライアント/サーバーの組み合わせによっては、これより大きな
COMMAREA が可能な場合もありますが、機能する保証はありません。)
COMMAREA が不要な場合は、このフィールドをゼロに設定し、eci_commarea
にヌル・ポインターを指定します。
eci_timeout
CICS サーバーからの応答を待つ時間 (秒単位)。 0 の値は、限度を設定しない
ことを意味します。
タイムアウトが起こると、会話は異常終了します。
reserved1
出力パラメーター。
このフィールドは、以前は eci_system_ return_code でした。 CICS
Transaction Gateway バージョン 3.1 以降では、このフィールドは後方互換性用
に予約されています。このフィールドに戻される情報はありません。システ
ム・エラーはすべて、CICS Transaction Gateway のエラー・ログに書き込まれ
ます。
eci_extend_mode
必須の入力パラメーター。
作業論理単位がこの呼び出しの最後で終了するかどうかを決める整数フィール
ドです。 (詳細については、「CICS Transaction Gateway: プログラミング・ガ
イド」の ECI における作業論理単位の表を参照してください。)
このフィールド (シンボル名で表示) の値は、以下のとおりです。
ECI_NO_EXTEND
1. 入力フィールド eci_luw_token がゼロの場合は、これが作業論理
単位に対する唯一の呼び出しです。
106
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
2. 入力フィールド eci_luw_token がゼロではない場合、これが指定
された作業論理単位に対する最後の呼び出しです。
いずれの場合も、リカバリー可能リソースへの変更は、CICS タスク
終了同期点によってコミットされ、作業論理単位は終了します。
eci_extend_mode を ECI_NO_EXTEND に設定し、eci_luw_token を 0
に設定した場合、クライアントからサーバーへの要求フローが 1 つ
と、サーバーからクライアントへの応答フローが 1 つ発生します。
eci_program_name で指定されたプログラムが呼び出され、そのプログ
ラムによって行われた変更がコミットされると、サーバーは応答を送
信します。
ECI_EXTENDED
1. 入力フィールド eci_luw_token がゼロの場合は、これが継続する
作業論理単位に対する最初の呼び出しです。
2. 入力フィールド eci_luw_token がゼロではない場合、この呼び出
しは指定された作業論理単位の継続を意図しています。
いずれの場合も、呼び出されたプログラムの正常終了後、作業論理単
位は継続し、リカバリー可能リソースに対する変更はコミットされな
いままになります。
ECI_COMMIT
入力フィールド eci_luw_token で識別される現行の作業論理単位を終
了し、リカバリー可能リソースに対して行われたすべての変更をコミ
ットします。
ECI_BACKOUT
入力の eci_luw_token フィールドで識別される現行の作業論理単位を
終了し、リカバリー可能リソースに対して行われたすべての変更をバ
ックアウトします。
eci_luw_token
必須の入出力パラメーター。
呼び出しが属する作業論理単位を識別するために使用する整数フィールドで
す。これは、作業論理単位の開始時にゼロに設定する必要があります (作業論
理単位が拡張される予定であるかどうかに関係なく)。作業論理単位が拡張され
る場合は、ECI は作業論理単位の最初の呼び出しで、eci_luw_token を有効な
値を用いて更新します。この値は、同じ作業論理単位に関連した後続のすべて
の呼び出しに対する入力として使用してください。 (詳細については、「CICS
Transaction Gateway: プログラミング・ガイド」の ECI における作業論理単位
の表を参照してください。)
戻りコードが ECI_NO_ERROR ではなく、かつ、呼び出しが既存の作業論理単
位を継続または終了する場合は、このフィールドは作業論理単位の状態を報告
する出力として使用されます。このフィールドがゼロに設定されている場合
第 4 章 C および COBOL
107
作成日付: 2005年12月2日
は、作業論理単位は終了し、その更新情報はバックアウトされています。ゼロ
以外の場合は、このフィールドは入力値と同じであり、作業論理単位は継続
し、その更新はまだ保留中です。
eci_sysid
必須の入力パラメーター。
将来の利用のために予約済みですが、各作業論理単位の開始前に、このフィー
ルドはヌルで初期化しておく必要があります。
eci_version
必須の入力パラメーター。
アプリケーションのコーディングに対応する ECI のバージョン。
ECI_VERSION_1A の値を使用します。
eci_system_name
オプションの入力パラメーター。
ECI 要求の対象となるサーバーの名前を指定する 8 文字のフィールドです。
使用していない文字部分はスペースで埋めてください。これを指定する場合
は、CICS_EciListSystems が戻したサーバー名のいずれかを指定する必要があ
ります。この値は、eci_luw_token がゼロに設定されている場合は、いつでも
指定できます。 (サーバーは作業論理単位の開始時点で確立されるため、
eci_luw_token がゼロではない場合にこれを指定すると無視されます。)
フィールドがヌルに設定されている場合は、デフォルトのサーバーが選択され
ます。つまり、選択されたサーバーの名前がこのフィールドに戻され、後続
の、関連する ECI 要求ではこの名前を使用する必要があります。異なる作業
論理単位で行われる ECI 要求でも、対象となるサーバーが同じ場合は、その
サーバーの名前を eci_system_name で示す必要があります。
eci_userid2
オプションの入力パラメーター。
eci_userid フィールドがヌルに設定されている場合は、eci_userid2 フィールド
には、サーバーで権限の妥当性検査のために使用するユーザー ID があればそ
れを指定します。ユーザー ID は最大 16 文字まで可能です。
ユーザー ID の使用法については、eci_userid フィールドの説明を参照してく
ださい。
eci_password2
オプションの入力パラメーター。
eci_password フィールドがヌルに設定されている場合は、eci_password2 フィ
ールドには、サーバーで権限の妥当性検査のために使用するパスワードがあれ
ばそれを指定します。パスワードは最大 16 文字まで可能です。
パスワードの使用法については、eci_password フィールドの説明を参照してく
ださい。
108
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
eci_tpn
オプションの入力パラメーター。
ECI 要求を処理するサーバーで使用されるトランザクションのトランザクショ
ン ID を指定する 4 文字のフィールドです。このトランザクションは、CICS
ミラー・トランザクションとしてサーバーで定義する必要があります。このフ
ィールドが設定されていない場合は、デフォルトのミラー・トランザクション
CPMI が使用されます。
ECI 要求を拡張する (eci_extend_mode の説明を参照) 場合は、このパラメー
ターは最初の要求に対してのみ意味を持ちます。
このフィールドを使用すると、eci_transid の内容は無視されます。
戻りコード: 101 ページの『CICS_ExternalCall ECI_Parms』における
CICS_ExternalCall の戻りコードの一般リストも参照してください。
ECI_NO_ERROR
呼び出しは正常に完了しました。
ECI_ERR_INVALID_DATA_LENGTH
eci_commarea_length フィールドの値が有効範囲の外側にあります。あるい
は、eci_commarea の値と矛盾しており、ヌル以外の eci_commarea ポインタ
ーに対してゼロ、またはヌルの eci_commarea ポインターに対してゼロ以外に
なっています。
ECI_ERR_INVALID_EXTEND_MODE
eci_extend_mode フィールドの値が無効です。
ECI_ERR_NO_CICS
CICS Transaction Gateway が使用できないか、サーバー・インプリメンテーシ
ョンが使用できません。あるいは、作業論理単位を開始する予定なのに、
eci_system_name で指定された CICS サーバーが使用できません。リソースの
更新は行われませんでした。
ECI_ERR_CICS_DIED
作業論理単位を開始または継続する予定なのに、CICS サーバーが使用できま
せんでした。 eci_extend_mode が ECI_EXTENDED の場合は、変更はバック
アウトされ、作業論理単位は終了します。 eci_extend_mode が
ECI_NO_EXTEND、ECI_COMMIT、または ECI_BACKOUT の場合は、アプリ
ケーションは変更がコミットされたのか、それともバックアウトされたのかを
判別できません。したがって、これ以降の手動リカバリーに備えて、この状態
を記録しておく必要があります。
ECI_ERR_TRANSACTION_ABEND
要求したプログラムを実行した CICS トランザクションが異常終了しました。
第 4 章 C および COBOL
109
作成日付: 2005年12月2日
異常終了コードは、eci_abend_code にあります。異常終了コードとその意味に
ついては、要求の対象となったサーバー・システムの資料を参照してくださ
い。
ECI_ERR_LUW_TOKEN
eci_luw_token で指定された値が無効です。
ECI_ERR_ALREADY_ACTIVE
既存の作業論理単位を継続しょうとしましたが、同じ作業論理単位に対して未
解決の非同期呼び出しがありました。
ECI_ERR_RESOURCE_SHORTAGE
サーバー・インプリメンテーションまたはクライアント・デーモンには、要求
を完了するのに十分なリソースがありませんでした。
ECI_ERR_NO_SESSIONS
新規の作業論理単位が作成されましたが、アプリケーションには、構成がサポ
ートしている未解決の作業論理単位の数と同じ数の作業論理単位がすでに存在
しています。
ECI_ERR_INVALID_DATA_AREA
ECI パラメーター・ブロックへのポインター、または eci_commarea で指定さ
れたポインターのいずれかが無効です。
ECI_ERR_ROLLEDBACK
作業論理単位をコミットしようとしましたが、サーバーは変更をコミットでき
ず、代わりに変更をバックアウトしました。
ECI_ERR_UNKNOWN_SERVER
要求されたサーバーが見つかりませんでした。 CICS_EciListSystems によって
戻されたサーバーのみが受け入れ可能です。
ECI_ERR_MAX_SESSIONS
構成ファイルで定義されている MAXREQUESTS の限度を超えた場合には、こ
れが戻されます。
ECI_ERR_MAX_SYSTEMS
構成で許可された数以上のサーバーに対して、要求を開始しようとしました。
使用できるサーバー数を制御する方法については、ご使用の CICS Transaction
Gateway またはサーバーの資料を参照してください。
ECI_ERR_SECURITY_ERROR
ユーザー ID とパスワードの有効な組み合わせが指定されませんでした。
ECI_ASYNC 呼び出しタイプ
環境:
110
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
目的: ECI_ASYNC 呼び出しタイプは、作業論理単位を開始、継続、または終了する
ための非同期プログラム・リンク呼び出しを提供します。呼び出し側アプリケーション
は、ECI が要求を受け入れると、制御を取り戻します。この時点でパラメーターが検査
されます。ただし、要求は後で処理するために、まだキューに入れられたままです。
コールバック・ルーチンが用意されていない場合は、アプリケーションは応答請求呼び
出しを使用して、要求が終了したかどうか、および結果がどうであったか、を判断する
必要があります。
コールバック・ルーチンが用意されている場合は、応答が可能になった時点で、コール
バック・ルーチン eci_callback が呼び出されます。
注: コンパイラーによっては、コールバック・ルーチンをサポートしていないものもあ
ります。詳細については、ご使用のコンパイラーの資料を参照してください。
重要なことですが、未解決の ECI_ASYNC 呼び出しの Eci パラメーター・ブロッ
クは、呼び出しの結果を受け取る前には変更されません。呼び出しの結果を受け取
る前にこのブロックが変更された場合は、誤った結果になります。
コールバック・ルーチンが呼び出されると、1 つのパラメーターを渡されます eci_message_qualifier で指定された値です。これによってコールバック・ルーチンは、
完了している非同期ルーチンを識別することができます。コールバック・ルーチンを使
用する際には、以下のガイドラインに従ってください。
1. コールバック・ルーチン内では、考えられる最低限の処理を行ってください。
2. コールバック・ルーチン内から ECI 関数を呼び出すことはできません。
3. コールバック・ルーチンは、ECI アプリケーションを実行中のオペレーティング・
システムに対して適切な方法を使用すれば応答が可能であることをアプリケーション
本体に知らせる必要があります。たとえばマルチスレッド環境では、コールバック・
ルーチンは、イベントが発生したことを知らせるセマフォーを別のスレッドにポスト
することがあります。
4. コールバック・ルーチンではなくアプリケーションが、応答請求呼び出しを使用し
て、実際の応答を受け取る必要があります。
ECI パラメーター・ブロック・フィールド: 入力パラメーター・フィールドを設
定する前に、ECI パラメーター・ブロックをヌルに設定します。
eci_call_type
必須の入力パラメーター。
ECI_ASYNC に設定する必要があります。
eci_program_name
入力専用であり、eci_extend_mode が ECI_COMMIT または ECI_BACKOUT
第 4 章 C および COBOL
111
作成日付: 2005年12月2日
以外の場合は必須です。 (詳細については、「CICS Transaction Gateway: プロ
グラミング・ガイド」の ECI における作業論理単位の表を参照してくださ
い。)
呼び出されるプログラムの名前を含む 8 文字のフィールドです。使用してい
ない文字部分はスペースで埋めてください。このフィールドは、大文字に変換
されずにサーバーへ送信されます。
使用される文字は、クライアントのコード・ページから EBCDIC コード・ペ
ージへ、送信する前に変換されます。サーバーが ASCII コード・ページを使
用している場合は、文字は再変換されます。この変換において不変であること
が保証されている文字は、大文字の A から Z と数字の 0 から 9 だけです。
一部の EBCDIC サーバー (カタカナおよびヘブライ語文字セット A) では、英
小文字の標準表記を使用していません。したがって、そのようなサーバーとの
通信では、英小文字の使用には注意してください。
eci_userid
必須の入力パラメーター。
ユーザー ID の入った 8 文字のフィールドです。使用していない文字部分はス
ペースで埋めてください。
CICS Transaction Gateway およびサーバーの資料を調べて、このフィールドが
サーバーに送信される前に大文字に変換されるかどうかを確認してください。
(8 文字より長いユーザー ID またはパスワードが必要な場合は、eci_userid お
よび eci_password をヌルに設定し、代わりにフィールド eci_userid2 および
eci_password2 を使用してください。)
ユーザー ID が指定された場合、サーバーはユーザー ID、およびパスワード
が指定されている場合はパスワードも使用して、ユーザーの認証を行います。
指定されたユーザー ID とパスワードは、これ以降、サーバーでのセキュリテ
ィー検査に使用されます。
eci_password
必須の入力パラメーター。
パスワードの入った 8 文字のフィールドです。使用していない文字部分はスペ
ースで埋めてください。
CICS Transaction Gateway およびサーバーの資料を調べて、このフィールドが
サーバーに送信される前に大文字に変換されるかどうかを確認してください。
(8 文字より長いユーザー ID またはパスワードが必要な場合は、eci_userid お
よび eci_password をヌルに設定し、代わりにフィールド eci_userid2 および
eci_password2 を使用してください。)
eci_transid
オプションの入力パラメーター。
112
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
オプションで CICS トランザクションの入っている 4 文字のフィールドで
す。使用していない文字部分はスペースで埋めてください。 eci_tpn (ヌル以外
の任意の値に設定されている) を使用する場合は、このパラメーターは無視さ
れます。このパラメーターの用途は、要求を送信するクライアントによって異
なります。 eci_transid の値は、大文字変換なしで ASCII から EBCDIC に変
換され、eci_program_name で指定されているプログラムへの LINK の間は
EIBTRNID に保管されます。
呼び出されたプログラムはミラー・トランザクション CPMI のもとで実行され
ますが、eci_transid トランザクション名のもとでリンクされます。この名前
は、呼び出されたプログラムがトランザクション ID を照会する際に使用でき
ます。サーバーによっては、トランザクション ID を使用して、呼び出された
プログラムのセキュリティー属性とパフォーマンス属性を判別する場合があり
ます。このようなサーバーでは、呼び出されたプログラムの処理を制御するの
に、このパラメーターを使用することをお勧めします。
ECI 要求を拡張する ( 114 ページの『eci_extend_mode』を参照) 場合は、
eci_transid パラメーターは、作業単位の最初の呼び出しに対してのみ意味を持
ちます。
このフィールドがすべてヌルで、eci_tpn が指定されていない場合は、デフォ
ルトのサーバー・トランザクション ID が使用されます。
eci_commarea
必須の入力パラメーター。
呼び出された CICS プログラムに、その COMMAREA として渡されるデータ
へのポインター。
COMMAREA が不要な場合は、ヌル・ポインターを指定し、長さ
(eci_commarea_length で指定) をゼロに設定します。
アプリケーションのコード・ページがサーバーのコード・ページと異なる場合
は、サーバーでデータ変換を行う必要があります。これを行うには、DFHCNV
マクロ定義などの CICS 提供のリソース変換機能を使用します。
eci_commarea_length
必須の入力パラメーター。
COMMAREA の長さをバイトで表します。この値は、32 500 を超えてはなり
ません。 (クライアント/サーバーの組み合わせによっては、これより大きな
COMMAREA が可能な場合もありますが、機能する保証はありません。)
COMMAREA が不要な場合は、このフィールドをゼロに設定し、eci_commarea
にヌル・ポインターを指定します。
eci_timeout
CICS サーバーからの応答を待つ時間 (秒単位)。 0 の値は、限度を設定しない
ことを意味します。
第 4 章 C および COBOL
113
作成日付: 2005年12月2日
タイムアウトが起こると、会話は異常終了します。
reserved1
出力パラメーター。
このフィールドは、以前は eci_system_ return_code でした。 CICS
Transaction Gateway バージョン 3.1 以降では、このフィールドは後方互換性用
に予約されています。このフィールドに戻される情報はありません。システ
ム・エラーはすべて、エラー・ログに書き込まれます。
eci_extend_mode
必須の入力パラメーター。
作業論理単位がこの呼び出しの後で終了するかどうかを判別する整数フィール
ドです。 (詳細については、「CICS Transaction Gateway: プログラミング・ガ
イド」の ECI における作業論理単位の表を参照してください。)
このフィールド (シンボル名で表示) の値は、以下のとおりです。
ECI_NO_EXTEND
1. 入力フィールド eci_luw_token がゼロの場合は、これが作業論理
単位に対する唯一の呼び出しです。
2. 入力フィールド eci_luw_token がゼロではない場合、これが指定
された作業論理単位に対する最後の呼び出しです。
いずれの場合も、リカバリー可能リソースへの変更は、CICS タスク
終了同期点によってコミットされ、作業論理単位は終了します。
ECI_EXTENDED
1. 入力フィールド eci_luw_token がゼロの場合は、これが継続する
作業論理単位に対する最初の呼び出しです。
2. 入力フィールド eci_luw_token がゼロではない場合、この呼び出
しは指定された作業論理単位の継続を意図しています。
いずれの場合も、呼び出されたプログラムの終了後、作業論理単位は
継続し、リカバリー可能リソースに対する変更はコミットされないま
まになります。
ECI_COMMIT
入力フィールド eci_luw_token で識別される現行の作業論理単位を終
了し、リカバリー可能リソースに対して行われたすべての変更をコミ
ットします。
ECI_BACKOUT
入力フィールド eci_luw_token で識別される現行の作業論理単位を終
了し、リカバリー可能リソースに対して行われたすべての変更をバッ
クアウトします。
114
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
eci_message_qualifier
オプションの入力パラメーター。
アプリケーションが、複数の非同期呼び出しを行う場合、それぞれの呼び出し
を識別できるようにするための整数フィールドです。コールバック・ルーチン
が指定されている場合は、このフィールドの値は、通知プロセスの際にコール
バック・ルーチンに戻されます。
eci_luw_token
必須の入出力パラメーター。
呼び出しが属する作業論理単位を識別するために使用する整数フィールドで
す。これは、作業論理単位の開始時にはゼロに設定されている必要があります
(作業論理単位が拡張される予定であるかどうかに関係なく)。 ECI は作業論理
単位の最初の (または唯一の) 呼び出し時に、このフィールドを有効な値で更
新します。作業論理単位が拡張される場合は、この値は、同じ作業論理単位に
関連する後続のすべての呼び出しに対して、入力として使用する必要がありま
す。 (詳細については、「CICS Transaction Gateway: プログラミング・ガイ
ド」の ECI における作業論理単位の表を参照してください。)
戻りコードが ECI_NO_ERROR ではなく、かつ、呼び出しが既存の作業論理単
位を継続または終了する場合は、このフィールドは作業論理単位の状態を報告
する出力として使用されます。このフィールドがゼロに設定されている場合
は、作業論理単位は終了し、その更新情報はバックアウトされています。ゼロ
以外の場合は、このフィールドは入力値と同じであり、作業論理単位は継続
し、その更新はまだ保留中です。
eci_sysid
必須の入力パラメーター。
将来の利用のために予約済みですが、各作業論理単位の開始前に、このフィー
ルドはヌルで初期化しておく必要があります。
eci_version
必須の入力パラメーター。
アプリケーションのコーディングに対応する ECI のバージョン。
ECI_VERSION_1A の値を使用します。
eci_system_name
オプションの入力パラメーター。
ECI 要求の対象となるサーバーの名前を指定する 8 文字のフィールドです。
使用していない文字部分はスペースで埋めてください。この値は、
eci_luw_token がゼロに設定されている場合は、いつでも指定できます。(サー
バーは作業論理単位の開始時点で確立されるため、eci_luw_token がゼロでは
ない場合にこれを指定すると無視されます。)
第 4 章 C および COBOL
115
作成日付: 2005年12月2日
このフィールドがヌルに設定されている場合は、デフォルト・サーバーが選択
されます。選択されたサーバーの名前は、この非同期要求の結果を得るために
使用する応答請求呼び出しの eci_system_name フィールドから取得できます。
(この後、異なる作業論理単位で行われる ECI 要求でも、対象となるサーバー
がこの要求と同じ場合は、そのサーバーの名前を要求の eci_system_name で示
す必要があります)
eci_callback
オプションの入力パラメーター。
非同期要求が完了したときに呼び出されるルーチンへのポインターです。 (コ
ールバック・ルーチンは、戻りコードが ECI_NO_ERROR で、かつ、ポインタ
ーがヌル以外の場合のみ、呼び出されます。)
eci_userid2
オプションの入力パラメーター。
eci_userid フィールドがヌルに設定されている場合は、eci_userid2 フィールド
には、サーバーで権限の妥当性検査のために使用するユーザー ID があればそ
れを指定します。ユーザー ID は最大 16 文字まで可能です。
ユーザー ID の使用法については、eci_userid フィールドの説明を参照してく
ださい。
eci_password2
オプションの入力パラメーター。
eci_password フィールドがヌルに設定されている場合は、eci_password2 フィ
ールドには、サーバーで権限の妥当性検査のために使用するパスワードがあれ
ばそれを指定します。パスワードは最大 16 文字まで可能です。
パスワードの使用法については、eci_password フィールドの説明を参照してく
ださい。
eci_tpn
オプションの入力パラメーター。
ECI 要求を処理するサーバーで使用されるトランザクションのトランザクショ
ン ID を指定する 4 文字のフィールドです。このトランザクションは、CICS
ミラー・トランザクションとしてサーバーで定義する必要があります。このフ
ィールドが設定されていない場合は、デフォルトのミラー・トランザクション
CPMI が使用されます。
ECI 要求を拡張する (eci_extend_mode の説明を参照) 場合は、このパラメー
ターは最初の要求に対してのみ意味を持ちます。
このフィールドを使用すると、eci_transid の内容は無視されます。
戻りコード:
101 ページの『CICS_ExternalCall ECI_Parms』における
CICS_ExternalCall の戻りコードの一般リストも参照してください。
116
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
戻りコードが ECI_NO_ERROR ではない場合は、コールバック・ルーチンは呼び出され
ず、この要求に対する非同期応答はありません。
ECI_NO_ERROR
ECI への呼び出しは正常に終了しました。これまでエラーは検出されていませ
ん。要求が完了すると、コールバック・ルーチンが呼び出されます。
ECI_ERR_INVALID_DATA_LENGTH
eci_commarea_length フィールドの値が有効な範囲の外側にあります。あるい
は、eci_commarea の値と矛盾しており、ヌル以外の eci_commarea ポインタ
ーに対してゼロ、またはヌルの eci_commarea ポインターに対してゼロ以外に
なっています。
ECI_ERR_INVALID_EXTEND_MODE
eci_extend_mode フィールドの値が無効です。
ECI_ERR_NO_CICS
クライアントまたはサーバーのいずれかのインプリメンテーションが使用でき
ません。
ECI_ERR_LUW_TOKEN
eci_luw_token で指定された値が無効です。
ECI_ERR_THREAD_CREATE_ERROR
サーバー・インプリメンテーションまたはクライアントが、要求を処理するス
レッドの作成に失敗しました。
ECI_ERR_ALREADY_ACTIVE
既存の作業論理単位を継続しょうとしましたが、同じ作業論理単位に対して未
解決の非同期呼び出しがありました。
ECI_ERR_RESOURCE_SHORTAGE
サーバー・インプリメンテーションまたはクライアントには、要求を完了する
のに十分なリソースがありませんでした。
ECI_ERR_NO_SESSIONS
新規の作業論理単位が作成されましたが、アプリケーションには、構成がサポ
ートしている未解決の作業論理単位の数と同じ数の作業論理単位がすでに存在
しています。
ECI_ERR_INVALID_DATA_AREA
ECI パラメーター・ブロックへのポインター、または eci_commarea で指定さ
れたポインターのいずれかが無効です。
ECI_STATE_SYNC 呼び出しタイプ
環境: ECI_STATE_SYNC 呼び出しタイプは、あらゆる環境で使用できます。
目的: ECI_STATE_SYNC 呼び出しタイプは、同期状況情報呼び出しを提供します。
第 4 章 C および COBOL
117
作成日付: 2005年12月2日
ECI パラメーター・ブロック・フィールド: ECI パラメーター・ブロックは、入
力パラメーター・フィールドを設定する前に、ヌルに設定しておく必要があります。
eci_call_type
必須の入力パラメーター。
ECI_STATE_SYNC に設定する必要があります。
eci_commarea
入力パラメーター。eci_extend_mode の値が ECI_STATE_CANCEL 以外の場合
は必須です。
アプリケーションが、戻された COMMAREA (状況情報を含んでいる) を受け
取るストレージ域へのポインター。詳細については、「CICS Transaction
Gateway: プログラミング・ガイド」の外部呼び出しインターフェースの章に
ある状況情報の呼び出し、および 132 ページの『ECI 状況ブロック』を参照
してください。
eci_extend_mode の値が ECI_STATE_CANCEL の場合は、ヌル・ポインターを
設定し、長さ (eci_commarea_length で指定) をゼロに設定します。
eci_commarea_length
eci_extend_mode の値が ECI_STATE_CANCEL 以外の場合は、必須の入出力パ
ラメーター。
COMMAREA の長さをバイトで表します。これは、状況情報 COMMAREA の
レイアウトを与える ECI_STATUS 構造の長さである必要があります。詳細に
ついては、「CICS Transaction Gateway: プログラミング・ガイド」の外部呼
び出しインターフェースの章にある状況情報の呼び出し、および 132 ページ
の『ECI 状況ブロック』を参照してください。領域サイズは、32 500 バイトを
超えてはなりません。
COMMAREA が不要な場合は、このフィールドをゼロに設定し、eci_commarea
にヌル・ポインターを指定します。
reserved1
出力パラメーター。
このフィールドは、以前は eci_system_ return_code でした。 CICS
Transaction Gateway バージョン 3.1 以降では、このフィールドは後方互換性用
に予約されています。このフィールドに戻される情報はありません。システ
ム・エラーはすべて、エラー・ログに書き込まれます。
eci_extend_mode
必須の入力パラメーター。
呼び出しタイプの詳細を指定する整数フィールドです。このフィールド (シン
ボル名で表示) の値は、以下のとおりです。
118
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
ECI_STATE_IMMEDIATE
状況応答が使用可能になり次第、状況応答を強制的に送信します。戻
された COMMAREA のレイアウトは、ECI_STATUS 構造で定義され
ています。詳細については、「CICS Transaction Gateway: プログラミ
ング・ガイド」の外部呼び出しインターフェースの章にある状況情
報の呼び出し、および 132 ページの『ECI 状況ブロック』を参照し
てください。
ECI_STATE_CHANGED
状況が変更になった場合のみ、状況応答を強制的に送信します。指定
された COMMAREA は、アプリケーションが認めた状況を含んでい
る必要があります。アプリケーションが指定した状況に変更があった
場合のみ、応答が送信されます。 COMMAREA のレイアウトは、
ECI_STATUS 構造で定義されています。詳細については、「CICS
Transaction Gateway: プログラミング・ガイド」の外部呼び出しイン
ターフェースの章にある状況情報の呼び出し、および 132 ページの
『ECI 状況ブロック』を参照してください。即時応答で戻される
eci_luw_token フィールドは、要求を識別するためのトークンを提供
します。
ECI_STATE_CANCEL
ECI_STATE_CHANGED タイプの操作を取り消します。この要求で
は、COMMAREA は不要です。 eci_luw_token フィールドは、
ECI_STATE_CHANGED 呼び出しの際に受け取ったトークンを含んで
いる必要があります。
eci_luw_token
オプションの入出力パラメーター。
据え置き状況要求がセットアップされている場合 (eci_extend_mode が
ECI_STATE_CHANGED に設定)、要求を識別するトークンが eci_luw_token フ
ィールドに戻されます。
据え置き状況要求が取り消された場合 (eci_extend_mode が
ECI_STATE_CANCEL に設定)、eci_luw_token フィールドは、
ECI_STATE_CHANGED 呼び出しの際に受け取ったトークンを含んでいる必要
があります。
eci_extend_mode に他の値が指定された場合は、このフィールドは使用しませ
ん。
eci_sysid
必須の入力パラメーター。
将来の利用のために予約済みですが、各作業論理単位の開始前に、このフィー
ルドはヌルで初期化しておく必要があります。
第 4 章 C および COBOL
119
作成日付: 2005年12月2日
eci_version
必須の入力パラメーター。
アプリケーションのコーディングに対応する ECI のバージョン。
ECI_VERSION_1A の値を使用します。
eci_system_name
オプションの入力パラメーター。
状況情報が必要なサーバーの名前を指定する 8 文字のフィールドです。使用し
ていない文字部分はスペースで埋めてください。これを指定する場合は、
CICS_EciListSystems が戻したサーバー名のいずれかを指定する必要がありま
す。この値は、eci_luw_token がゼロに設定されている場合は、いつでも指定
できます。
フィールドがヌルに設定されている場合は、デフォルトのサーバーが選択され
ます。つまり、選択されたサーバーの名前がこのフィールドに戻されます。
戻りコード: 101 ページの『CICS_ExternalCall ECI_Parms』における
CICS_ExternalCall の戻りコードの一般リストも参照してください。
ECI_NO_ERROR
呼び出しは正常に完了しました。
ECI_ERR_INVALID_DATA_LENGTH
eci_commarea_length フィールドの値が有効な範囲の外側にあります。あるい
は、eci_commarea の値と矛盾しており、ヌル以外の eci_commarea ポインタ
ーに対してゼロ、またはヌルの eci_commarea ポインターに対してゼロ以外に
なっています。
ECI_ERR_INVALID_EXTEND_MODE
eci_extend_mode フィールドの値が無効です。
ECI_ERR_LUW_TOKEN
eci_luw_token で指定された値が無効です。
ECI_ERR_INVALID_DATA_AREA
ECI パラメーター・ブロックへのポインター、または eci_commarea で指定さ
れたポインターのいずれかが無効です。
ECI_ERR_UNKNOWN_SERVER
要求されたサーバーが見つかりませんでした。 CICS_EciListSystems によって
戻されたサーバーのみが受け入れ可能です。
ECI_STATE_ASYNC 呼び出しタイプ
環境:
120
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
目的: ECI_STATE_ASYNC 呼び出しタイプは、非同期の状況情報呼び出しを提供しま
す。呼び出し側アプリケーションは、ECI が要求を受け入れると、制御を取り戻しま
す。この時点でパラメーターが検査されます。ただし、要求は後で処理するために、ま
だキューに入れられたままです。
コールバック・ルーチンが用意されていない場合は、アプリケーションは応答請求呼び
出しを使用して、要求が終了したかどうか、および結果がどうであったか、判別する必
要があります。
コールバック・ルーチンが用意されている場合は、応答が可能になった時点で、コール
バック・ルーチン eci_callback が呼び出されます。
注: コンパイラーによっては、コールバック・ルーチンをサポートしていないものもあ
ります。詳細については、ご使用のコンパイラーの資料を参照してください。
注: 重要なことですが、未解決の ECI_STATE_ASYNC 呼び出しの Eci パラメーター・
ブロックは、呼び出しの結果を受け取る前には変更されません。呼び出しの結果を
受け取る前にこのブロックが変更された場合は、誤った結果になります。
コールバック・ルーチンが呼び出されると、1 つのパラメーターを渡されます eci_message_qualifier で指定された値です。これによってコールバック・ルーチンは、
完了している非同期ルーチンを識別することができます。コールバック・ルーチンを使
用する際には、以下のガイドラインに注意してください。
1. コールバック・ルーチン内では、考えられる最低限の処理を行ってください。
2. コールバック・ルーチン内から ECI 関数を呼び出すことはできません。
3. コールバック・ルーチンは、ECI アプリケーションを実行中のオペレーティング・
システムに対して適切な方法を使用すれば応答が可能であることをアプリケーション
本体に知らせる必要があります。たとえばマルチスレッド環境では、コールバック・
ルーチンは、イベントが発生したことを知らせるセマフォーを別のスレッドにポスト
することがあります。
4. コールバック・ルーチンではなくアプリケーションが、応答請求呼び出しを使用し
て、実際の応答を受け取る必要があります。
ECI パラメーター・ブロック・フィールド: ECI パラメーター・ブロックは、入
力パラメーター・フィールドを設定する前に、ヌルに設定しておく必要があります。
eci_call_type
必須の入力パラメーター。
ECI_STATE_ASYNC に設定する必要があります。
eci_commarea
入力パラメーター。eci_extend_mode の値が ECI_STATE_CANCEL 以外の場合
は必須です。
第 4 章 C および COBOL
121
作成日付: 2005年12月2日
アプリケーションが、戻された COMMAREA (状況情報を含んでいる) を受け
取るストレージ域へのポインター。詳細については、「CICS Transaction
Gateway: プログラミング・ガイド」の外部呼び出しインターフェースの章に
ある状況情報の呼び出し、および 132 ページの『ECI 状況ブロック』を参照
してください。
eci_extend_mode の値が ECI_STATE_CANCEL の場合は、ヌル・ポインターを
設定し、長さ (eci_commarea_length で指定) をゼロに設定します。
eci_commarea_length
eci_extend_mode の値が ECI_STATE_CANCEL 以外の場合は、必須の入力パラ
メーターです。
COMMAREA の長さをバイトで表します。これは、状況情報 COMMAREA の
レイアウトを与える ECI_STATUS 構造の長さである必要があります。詳細に
ついては、「CICS Transaction Gateway: プログラミング・ガイド」の外部呼
び出しインターフェースの章にある状況情報の呼び出し、および 132 ページ
の『ECI 状況ブロック』を参照してください。領域サイズは、32 500 バイトを
超えてはなりません。
COMMAREA が不要な場合は、このフィールドをゼロに設定し、eci_commarea
にヌル・ポインターを指定します。
reserved1
出力パラメーター。
このフィールドは、以前は eci_system_ return_code でした。 CICS
Transaction Gateway バージョン 3.1 以降では、このフィールドは後方互換性用
に予約されています。このフィールドに戻される情報はありません。システ
ム・エラーはすべて、エラー・ログに書き込まれます。
eci_extend_mode
必須の入力パラメーター。
呼び出しタイプの詳細を指定する整数フィールドです。このフィールド (シン
ボル名で表示) の値は、以下のとおりです。
ECI_STATE_IMMEDIATE
状況応答が使用可能になり次第、強制的に送信します。戻された
COMMAREA のレイアウトは、ECI_STATUS 構造で定義されていま
す。詳細については、「CICS Transaction Gateway: プログラミング・
ガイド」の外部呼び出しインターフェースの章にある状況情報の呼
び出し、および 132 ページの『ECI 状況ブロック』を参照してくだ
さい。
ECI_STATE_CHANGED
状況が変更になった場合のみ、状況応答を強制的に送信します。指定
された COMMAREA は、アプリケーションが認めた状況を含んでい
る必要があります。アプリケーションが指定した状況に変更があった
122
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
場合のみ、応答が送信されます。 COMMAREA のレイアウトは、
ECI_STATUS 構造で定義されています。詳細については、「CICS
Transaction Gateway: プログラミング・ガイド」の外部呼び出しイン
ターフェースの章にある状況情報の呼び出し、および 132 ページの
『ECI 状況ブロック』を参照してください。即時応答で戻される
eci_luw_token フィールドは、この要求が属する作業論理単位を示し
ます。
ECI_STATE_CANCEL
ECI_STATE_CHANGED タイプの操作を取り消します。この要求で
は、COMMAREA は不要です。 eci_luw_token フィールドは、
ECI_STATE_CHANGED 呼び出しの際に受け取ったトークンを含んで
いる必要があります。
eci_message_qualifier
オプションの入力パラメーター。
複数の非同期呼び出しを行う場合、それぞれの呼び出しを識別できるようにす
る整数フィールドです。コールバック・ルーチンが指定されている場合は、こ
のフィールドの値は、通知プロセスの際にコールバック・ルーチンに戻されま
す。
eci_luw_token
オプションの入出力パラメーター。
据え置き状況要求がセットアップされている場合 (eci_extend_mode が
ECI_STATE_CHANGED に設定)、要求を識別するトークンが eci_luw_token フ
ィールドに戻されます。
据え置き状況要求が取り消された場合 (eci_extend_mode が
ECI_STATE_CANCEL に設定)、eci_luw_token フィールドは、
ECI_STATE_CHANGED 呼び出しの際に受け取ったトークンを含んでいる必要
があります。
eci_extend_mode に他の値が指定された場合は、このフィールドは使用しませ
ん。
eci_sysid
必須の入力パラメーター。
将来の利用のために予約済みですが、各作業論理単位の開始前に、このフィー
ルドはヌルで初期化しておく必要があります。
eci_version
必須の入力パラメーター。
アプリケーションのコーディングに対応する ECI のバージョン。
ECI_VERSION_1A の値を使用します。
第 4 章 C および COBOL
123
作成日付: 2005年12月2日
eci_system_name
オプションの入力パラメーター。
状況情報要求の対象となるサーバーの名前を指定する 8 文字のフィールドで
す。使用していない文字部分はスペースで埋めてください。これを指定する場
合は、CICS_EciListSystems が戻したサーバー名のいずれかを指定する必要が
あります。この値は、eci_luw_token がゼロに設定されている場合は、いつで
も指定できます。
このフィールドがヌルに設定されている場合は、デフォルト・サーバーが選択
されます。選択されたサーバーの名前は、この非同期要求の結果を得るために
使用する応答請求呼び出しの eci_system_name フィールドにあります。
eci_callback
オプションの入力パラメーター。
非同期要求が完了したときに呼び出されるルーチンへのポインターです。 (コ
ールバック・ルーチンは、戻りコードが ECI_NO_ERROR で、かつ、ポインタ
ーがヌル以外の場合のみ、呼び出されます。)
戻りコード:
101 ページの『CICS_ExternalCall ECI_Parms』における
CICS_ExternalCall の戻りコードの一般リストも参照してください。
戻りコードが ECI_NO_ERROR ではない場合は、コールバック・ルーチンは呼び出され
ず、この要求に対する非同期応答はありません。
ECI_NO_ERROR
呼び出しは正常に完了しました。
ECI_ERR_INVALID_DATA_LENGTH
eci_commarea_length フィールドの値が有効な範囲の外側にあります。あるい
は、eci_commarea の値と矛盾しており、ヌル以外の eci_commarea ポインタ
ーに対してゼロ、またはヌルの eci_commarea ポインターに対してゼロ以外に
なっています。
ECI_ERR_INVALID_EXTEND_MODE
eci_extend_mode フィールドの値が無効です。
ECI_ERR_LUW_TOKEN
eci_luw_token で指定された値が無効です。
ECI_ERR_INVALID_DATA_AREA
ECI パラメーター・ブロックへのポインター、または eci_commarea で指定さ
れたポインターのいずれかが無効です。
ECI_GET_REPLY 呼び出しタイプ
目的: ECI_GET_REPLY 呼び出しタイプは応答請求呼び出しを提供し、すべての非同
期要求で未解決の応答があれば、適切な情報を戻します。そのような応答がない場合
124
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
は、ECI_ERR_NO_REPLY が戻されます。(応答があるまでアプリケーションを待機させ
るためには、代わりに、ECI_GET_REPLY_WAIT 呼び出しタイプを使用してくださ
い。)
注: 重要なことですが、未解決の ECI_ASYNC 呼び出しの Eci パラメーター・ブロッ
クは、呼び出しの結果を受け取る (たとえば、この GET REPLY 呼び出しを使用)
前には変更されません。呼び出しの結果を受け取る前にこのブロックが変更された
場合は、誤った結果になります。
ECI パラメーター・ブロック・フィールド: ECI パラメーター・ブロックは、入
力パラメーター・フィールドを設定する前に、ヌルに設定しておく必要があります。
以下のフィールドは、入力として指定可能な ECI パラメーター・ブロックのフィール
ドを示しています。
ECI_GET_REPLY 呼び出しにおいて、ECI パラメーター・ブロックは以下のように更新
されます。
1. 応答からのすべての出力が追加されます。入力フィールドが上書きされる場合もあり
ます。上書きされるフィールドは、非同期要求に対応する同期バージョンから出力さ
れるフィールドです。
2. この応答に関連した非同期要求への入力として指定された eci_message_qualifier の
値は復元されます。
3. COMMAREA へのポインターを除き、更新されていない入力は、いずれも未定義と
なります。これらのフィールドの内容は再使用しないようにしてください。
eci_call_type
必須の入力パラメーター。
ECI_GET_REPLY に設定する必要があります。
eci_commarea
オプションの入力パラメーター。
アプリケーションが、戻された COMMAREA を受け取るストレージ域へのポ
インター。戻された COMMAREA の内容は、応答が求められている非同期呼
び出しのタイプによって異なります。プログラム・リンク呼び出しの場合は、
呼び出されたプログラムから戻されるはずの COMMAREA です (存在する場
合)。状況情報呼び出しの場合は、eci_extend_mode の値が
ECI_STATE_CANCEL の場合以外は、状況情報を含んでいる COMMAREA で
す。詳細については、「CICS Transaction Gateway: プログラミング・ガイド」
の外部呼び出しインターフェースの章にある状況情報の呼び出し、および
132 ページの『ECI 状況ブロック』を参照してください。
COMMAREA が不要な場合は、ヌル・ポインターを指定し、長さ
(eci_commarea_length で指定) をゼロに設定します。
第 4 章 C および COBOL
125
作成日付: 2005年12月2日
アプリケーションのコード・ページがサーバーのコード・ページと異なる場合
は、サーバーでデータ変換を行う必要があります。これを行うには、DFHCNV
マクロ定義などの CICS 提供のリソース変換機能を使用します。
eci_commarea_length
必須の入力パラメーター。
COMMAREA の長さをバイトで表します。この値は、32 500 を超えてはなり
ません。 (クライアント/サーバーの組み合わせによっては、これより大きな
COMMAREA が可能な場合もありますが、機能する保証はありません。)
COMMAREA が不要な場合は、このフィールドをゼロに設定し、eci_commarea
にヌル・ポインターを指定します。
eci_sysid
必須の入力パラメーター。
将来の利用のために予約済みですが、各作業論理単位の開始前に、このフィー
ルドはヌルで初期化しておく必要があります。
eci_version
必須の入力パラメーター。
アプリケーションのコーディングに対応する ECI のバージョン。
ECI_VERSION_1A の値を使用します。
戻りコード: 101 ページの『CICS_ExternalCall ECI_Parms』における
CICS_ExternalCall の戻りコードの一般リストも参照してください。
ECI_NO_ERROR
この応答に関連した非同期要求が正常に終了しました。
ECI_ERR_INVALID_DATA_LENGTH
eci_commarea_length フィールドの値は、以下のいずれかの理由により、受け
入れられません。
v 有効な範囲の外側にあります。
v eci_commarea の値と矛盾しています。つまり、ヌル以外の eci_commarea
ポインターに対してゼロが、あるいはヌルの eci_commarea ポインターに対
してゼロ以外がこのフィールドの値に指定されています。
v この応答に関連した非同期要求からの COMMAREA の出力用には、このフ
ィールドの値は小さ過ぎます。
最後のケースの場合、eci_commarea_length 出力を使用すれば、より多くのス
トレージを COMMAREA に割り振ることができます。これによって、
ECI_GET_SPECIFIC_REPLY 呼び出しタイプで、eci_message_qualifier の出力
(非同期要求を一意的に識別できる場合) を使用して、応答を取り出します。
126
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
ECI_ERR_NO_CICS
この応答に関連した非同期要求の eci_system_name に指定された CICS サー
バーが使用できません。リソースの更新は行われませんでした。
ECI_ERR_CICS_DIED
この応答に関連した非同期要求によって、作業論理単位が開始または継続され
る予定でしたが、CICS サーバーが使用できませんでした。 eci_extend_mode
が ECI_EXTENDED の場合は、変更はバックアウトされ、作業論理単位は終了
します。 eci_extend_mode が ECI_NO_EXTEND、ECI_COMMIT、または
ECI_BACKOUT の場合は、アプリケーションは変更がコミットされたか、バッ
クアウトされたかを判別できません。したがって、これ以降の手動リカバリー
に備えて、この状態を記録しておく必要があります。
ECI_ERR_NO_REPLY
未解決の応答はありませんでした。
ECI_ERR_TRANSACTION_ABEND
この応答に関連した非同期要求によって、プログラムがサーバーで実行されま
したが、要求されたプログラムを実行した CICS トランザクションが異常終了
しました。異常終了コードは、eci_abend_code にあります。異常終了コードと
その意味については、要求対象のサーバー・システムの資料を参照してくださ
い。
ECI_ERR_THREAD_CREATE_ERROR
CICS サーバーまたは CICS Transaction Gateway が、この応答に関連した非同
期呼び出しを処理するスレッドの作成に失敗しました。
ECI_ERR_RESOURCE_SHORTAGE
サーバー・インプリメンテーションまたは CICS Transaction Gateway には、こ
の応答に関連した非同期要求を完了するのに十分なリソースがありませんでし
た。
ECI_ERR_INVALID_DATA_AREA
ECI パラメーター・ブロックへのポインター、または eci_commarea で指定さ
れたポインターのいずれかが無効です。
ECI_ERR_ROLLEDBACK
この応答に関連した非同期要求が作業論理単位をコミットしようとしました
が、サーバーは変更をコミットできず、代わりに変更をバックアウトしまし
た。
ECI_ERR_UNKNOWN_SERVER
この応答に関連した非同期要求が指定したサーバーが見つかりませんでした。
CICS_EciListSystems によって戻されたサーバーのみが受け入れ可能です。
ECI_ERR_MAX_SESSIONS
通信リソースが十分ではないため、この応答に関連した非同期要求を満たすこ
第 4 章 C および COBOL
127
作成日付: 2005年12月2日
とができませんでした。通信リソースを制御する方法については、ご使用の
CICS Transaction Gateway またはサーバーの資料を参照してください。
ECI_ERR_MAX_SYSTEMS
この応答に関連した非同期要求が、構成で許可された数以上のサーバーに対し
て、要求を開始しようとしました。使用できるサーバー数を制御する方法につ
いては、ご使用の CICS Transaction Gateway またはサーバーの資料を参照して
ください。
ECI_ERR_SECURITY_ERROR
この応答に関連した非同期要求で指定されたユーザー ID とパスワードの組み
合わせは、有効ではありませんでした。
ECI_GET_REPLY_WAIT 呼び出しタイプ
目的: ECI_GET_REPLY_WAIT 呼び出しタイプは応答請求呼び出しを提供し、すべて
の非同期要求で未解決の応答があれば、適切な情報を戻します。そのような応答がない
場合は、アプリケーションは応答があるまで待機します。(代わりに呼び出しタイプ
ECI_GET_REPLY を使用すれば、無応答の標識が得られます。)
注: 重要なことですが、未解決の ECI_STATE_ASYNC 呼び出しの Eci パラメーター・
ブロックは、呼び出しの結果を受け取る前には変更されません。呼び出しの結果を
受け取る前にこのブロックが変更された場合は、誤った結果になります。
ECI パラメーター・ブロック・フィールド: ECI_GET_REPLY の場合と同様です
が、eci_call_type は ECI_GET_REPLY_WAIT に設定する必要があります。
戻りコード: ECI_ERR_NO_REPLY を戻すことはできないという点を除けば、
ECI_GET_REPLY の場合と同様です。
ECI_GET_SPECIFIC_REPLY 呼び出しタイプ
目的: ECI_GET_SPECIFIC_REPLY 呼び出しタイプは応答請求呼び出しを提供し、
eci_message_qualifier 入力に一致する未解決の応答があれば、それに適した情報を戻し
ます。そのような応答がない場合は、ECI_ERR_NO_REPLY が戻されます。(応答がある
までアプリケーションを待機させるには、代わりに、ECI_GET_REPLY_WAIT 呼び出し
タイプを使用してください。)
注: 重要なことですが、未解決の ECI_STATE_ASYNC 呼び出しの Eci パラメーター・
ブロックは、呼び出しの結果を受け取る前には変更されません。呼び出しの結果を
受け取る前にこのブロックが変更された場合は、誤った結果になります。
ECI パラメーター・ブロック・フィールド: 入力パラメーター・フィールドを設
定する前に、ECI パラメーター・ブロックをヌルに設定します。
128
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
以下のフィールドは、入力として指定可能な ECI パラメーター・ブロックのフィール
ドを示しています。
ECI_GET_REPLY 呼び出しにおいて、ECI パラメーター・ブロックは以下のように更新
されます。
1. 応答からのすべての出力が追加されます。入力フィールドが上書きされる場合もあり
ます。上書きされるフィールドは、非同期要求に対応する同期バージョンから出力さ
れるフィールドです。
2. COMMAREA へのポインターおよび入力 eci_message_qualifier を除き、更新されて
いない入力はいずれも未定義となります。これらのフィールドの内容は再使用しない
ようにしてください。
eci_call_type
必須の入力パラメーター。
ECI_GET_SPECIFIC_REPLY に設定する必要があります。
eci_commarea
オプションの入力パラメーター。
アプリケーションが、戻された COMMAREA を受け取るストレージ域へのポ
インター。戻された COMMAREA の内容は、応答が求められている非同期呼
び出しのタイプによって異なります。プログラム・リンク呼び出しの場合は、
呼び出されたプログラムから戻されるはずの COMMAREA です (存在する場
合)。状況情報呼び出しの場合は、eci_extend_mode の値が
ECI_STATE_CANCEL の場合以外は、状況情報を含んでいる COMMAREA で
す。詳細については、「CICS Transaction Gateway: プログラミング・ガイド」
の外部呼び出しインターフェースの章にある状況情報の呼び出し、および
132 ページの『ECI 状況ブロック』を参照してください。
アプリケーションのコード・ページがサーバーのコード・ページと異なる場合
は、サーバーでデータ変換を行う必要があります。これを行うには、DFHCNV
マクロ定義などの CICS 提供のリソース変換機能を使用します。
eci_commarea_length
必須の入力パラメーター。
COMMAREA の長さをバイトで表します。この値は、32 500 を超えてはなり
ません。 (クライアント/サーバーの組み合わせによっては、これより大きな
COMMAREA が可能な場合もありますが、機能する保証はありません。)
eci_message_qualifier
必須の入力パラメーター。
応答を送信請求する非同期呼び出しを識別する整数フィールドです。
eci_sysid
必須の入力パラメーター。
第 4 章 C および COBOL
129
作成日付: 2005年12月2日
将来の利用のために予約済みですが、各作業論理単位の開始前に、このフィー
ルドはヌルで初期化しておく必要があります。
eci_version
必須の入力パラメーター。
アプリケーションのコーディングに対応する ECI のバージョン。
ECI_VERSION_1A の値を使用します。
戻りコード: 101 ページの『CICS_ExternalCall ECI_Parms』における
CICS_ExternalCall の戻りコードの一般リストも参照してください。
ECI_NO_ERROR
呼び出しは正常に完了しました。
ECI_ERR_INVALID_DATA_LENGTH
eci_commarea_length フィールドの値は、以下のいずれかの理由により、受け
入れられません。
v 有効な範囲の外側にあります。
v eci_commarea の値と矛盾しています。つまり、ヌル以外の eci_commarea
ポインターに対してゼロが、あるいはヌルの eci_commarea ポインターに対
してゼロ以外がこのフィールドの値に指定されています。
v この応答に関連した非同期要求からの COMMAREA の出力用には、このフ
ィールドの値は小さ過ぎます。
最後のケースの場合、eci_commarea_length 出力を使用すれば、より多くのス
トレージを COMMAREA に割り振ることができます。この後、
ECI_GET_SPECIFIC_REPLY 呼び出しを再試行します。
ECI_ERR_NO_CICS
この応答に関連した非同期要求の eci_system_name に指定された CICS サー
バーが使用できません。リソースの更新は行われませんでした。
ECI_ERR_CICS_DIED
この応答に関連した非同期要求によって、作業論理単位が開始または継続され
る予定でしたが、CICS サーバーが使用できませんでした。 eci_extend_mode
が ECI_EXTENDED の場合は、変更はバックアウトされ、作業論理単位は終了
します。 eci_extend_mode が ECI_NO_EXTEND、ECI_COMMIT、または
ECI_BACKOUT の場合は、アプリケーションは変更がコミットされたか、バッ
クアウトされたかを判別できません。したがって、これ以降の手動リカバリー
に備えて、この状態を記録しておく必要があります。
ECI_ERR_NO_REPLY
eci_message_qualifier の入力に一致した未解決の応答はありませんでした。
ECI_ERR_TRANSACTION_ABEND
この応答に関連した非同期要求によって、プログラムがサーバーで実行されま
したが、要求されたプログラムを実行した CICS トランザクションが異常終了
130
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
しました。異常終了コードは、eci_abend_code にあります。異常終了コードと
その意味については、要求対象のサーバー・システムの資料を参照してくださ
い。
ECI_ERR_THREAD_CREATE_ERROR
CICS サーバーまたは CICS Transaction Gateway が、この応答に関連した非同
期要求を処理するスレッドの作成に失敗しました。
ECI_ERR_RESOURCE_SHORTAGE
CICS サーバーまたは CICS Transaction Gateway には、この応答に関連した非
同期要求を完了するのに十分なリソースがありませんでした。
ECI_ERR_INVALID_DATA_AREA
ECI パラメーター・ブロックへのポインター、または eci_commarea で指定さ
れたポインターのいずれかが無効です。
ECI_ERR_ROLLEDBACK
この応答に関連した非同期要求が作業論理単位をコミットしようとしました
が、サーバーは変更をコミットできず、代わりに変更をバックアウトしまし
た。
ECI_ERR_UNKNOWN_SERVER
この応答に関連した非同期要求が指定したサーバーが見つかりませんでした。
CICS_EciListSystems によって戻されたサーバーのみが受け入れ可能です。
ECI_ERR_MAX_SESSIONS
通信リソースが十分ではないため、この応答に関連した非同期要求を満たすこ
とができませんでした。通信リソースを制御する方法については、ご使用の
CICS Transaction Gateway またはサーバーの資料を参照してください。
ECI_ERR_MAX_SYSTEMS
この応答に関連した非同期要求が、構成で許可された数以上のサーバーに対し
て、要求を開始しようとしました。使用できるサーバー数を制御する方法につ
いては、ご使用の CICS Transaction Gateway またはサーバーの資料を参照して
ください。
ECI_ERR_SECURITY_ERROR
この応答に関連した非同期要求で指定されたユーザー ID とパスワードの組み
合わせは、有効ではありませんでした。
ECI_GET_SPECIFIC_REPLY_WAIT 呼び出しタイプ
環境:
目的: ECI_GET_SPECIFIC_REPLY_WAIT 呼び出しタイプは応答請求呼び出しを提供
し、入力 eci_message_qualifier に一致する未解決の応答があれば、適切な情報を戻しま
第 4 章 C および COBOL
131
ECI 状況ブロック
作成日付: 2005年12月2日
す。そのような応答がない場合は、アプリケーションは応答があるまで待機します。(代
わりに、呼び出しタイプ ECI_GET_SPECIFIC_REPLY を使用すれば、無応答の標識が得
られます。)
注: 重要なことですが、未解決の ECI_STATE_ASYNC 呼び出しの Eci パラメーター・
ブロックは、呼び出しの結果を受け取る前には変更されません。呼び出しの結果を
受け取る前にこのブロックが変更された場合は、誤った結果になります。
ECI パラメーター・ブロック・フィールド: ECI_GET_SPECIFIC_REPLY の場合
と同様ですが、eci_call_type は ECI_GET_SPECIFIC_REPLY_WAIT に設定する必要が
あります。
戻りコード: ECI_ERR_NO_REPLY を戻すことはできないという点を除けば、
ECI_GET_SPECIFIC_REPLY の場合と同様です。
注: eci_extend mode が ECI_STATE_CHANGED に設定された未解決の
ECI_STATE_AYSNC 呼び出しに対して、ECI_GET_SPECIFIC_REPLY_WAIT 呼び出
しを出す場合、eci_extend_mode が ECI_STATE_CANCEL に設定された
ECI_STATE_ASYNC 呼び出しが出されると、応答は何も受信されません。
ECI 状況ブロック
ECI 状況ブロックは、状況情報呼び出しで ECI との間の情報の受け渡しに使用しま
す。これには、以下のフィールドがあります。
ConnectionType
アプリケーションを実行するシステムのタイプを指定する整数フィールドで
す。可能な値は以下のとおりです。
ECI_CONNECTED_NOWHERE
アプリケーションはいずれにも接続されていません。
ECI_CONNECTED_TO_CLIENT
アプリケーションは、クライアント・システムで実行中です。
ECI_CONNECTED_TO_SERVER
アプリケーションは、ECI のサーバー・インプリメンテーションを使
用しています。
CicsServerStatus
CICS サーバーの状態を指定する整数フィールドです。可能な値は以下のとお
りです。
ECI_SERVERSTATE_UNKNOWN
CICS サーバーの状態は判別できませんでした。
ECI_SERVERSTATE_UP
CICS サーバーではプログラムの実行が可能です。
132
CICS Transaction Gateway: プログラミング・リファレンス
ECI 状況ブロック
作成日付: 2005年12月2日
ECI_SERVERSTATE_DOWN
CICS サーバーでプログラムの実行はできません。
CicsClientStatus
クライアント・デーモンの状態を指定する整数フィールドです。可能な値は以
下のとおりです。
ECI_CLIENTSTATE_UNKNOWN
クライアント・デーモンの状態は判別できませんでした。
ECI_CLIENTSTATE_UP
クライアント・デーモンは ECI 呼び出しの受信が可能です。
ECI_CLIENTSTATE_INAPPLICABLE
アプリケーションは、ECI のサーバー・インプリメンテーションを使
用しています。
CICS_EciListSystems NameSpace Systems List
目的
CICS_EciListSystems 関数は、CICS_ExternalCall 要求が送信される CICS サーバーの
リストを提供します。クライアント・デーモンとリスト上のいずれかのサーバー間に通
信リンクが存在する保証も、いずれかのサーバーが要求を処理できる保証もありませ
ん。
サーバーのリストは、それぞれの CICS サーバーごとに 1 つのエレメントで、システ
ム情報の構造の配列として戻されます。この構造は、CICS_EciSystem_t と呼ばれ、以
下のフィールドを定義しています。
SystemName
CICS サーバーの名前を指定するヌル終了ストリングへのポインターです。名
前が CICS_ECI_SYSTEM_MAX より短い場合は、CICS_ECI_SYSTEM_MAX
+1 の長さまでヌルが埋め込まれます。
記述
システムの記述がある場合、それを提供するヌル終了ストリングへのポインタ
ーです。記述が CICS_ECI_DESCRIPTION_MAX より短い場合は、
CICS_ECI_DESCRIPTION_MAX +1 の長さまでヌルが埋め込まれます。
パラメーター
NameSpace
将来使用するために予約済みのポインターです。これは、ヌル・ポインターで
なければなりません。
Systems
このパラメーターは、関数への入力時に、List パラメーターで与える配列のエ
レメント数を指定します。戻り時には、検出された実際のシステム数が入って
います。
第 4 章 C および COBOL
133
ECI 状況ブロック
List
作成日付: 2005年12月2日
関数によって入力され、戻される CICS_EciSystem_t 構造の配列です。アプリ
ケーションは、配列用にストレージを用意して、Systems パラメーターが配列
のエレメント数を示すように設定する必要があります。リストの最初の名前
は、デフォルトのサーバーです。ただし、デフォルトを定義する方法は、オペ
レーティング・システムによって異なります。
戻りコード
ECI_NO_ERROR
関数が正常に完了しました。検出されたシステムの数は少なくとも 1 つであ
り、Systems パラメーターで入力として指定された値を超えていません。
ECI_ERR_MORE_SYSTEMS
List 配列のスペースが不足しているため、情報を保管できませんでした。指定
された配列は全部埋まっており、Systems パラメーターは検出されたシステム
の総数が入るように更新されました。そのため、配列を適切なサイズに再割り
振りして、関数を再試行することができます。
ECI_ERR_NO_SYSTEMS
CICS サーバーが見つかりません。この場合、Systems に戻される値はゼロで
す。
ECI_ERR_NO_CICS
クライアント・デーモンがアクティブではありません。
ECI_ERR_INVALID_DATA _LENGTH
Systems パラメーターで指定された値が大きすぎるため、List パラメーター用
のストレージの大きさが 32 767 を超えました。
ECI_ERR_CALL_FROM_CALLBACK
呼び出しがコールバック・ルーチンから行われました。
ECI_ERR_SYSTEM_ERROR
内部システム・エラーが発生しました。
外部表示インターフェース
EPI 定数およびデータ構造
このセクションでは、EPI を使用する際に必要となる定数とデータ構造について説明し
ます。これらは、 140 ページの『EPI 関数』で参照しています。
EPI 定数
以下の定数は、この章における EPI データ構造、関数、およびイベントの説明で、シン
ボル名で参照されています。説明を分かりやすくするために、ここではその値も示して
います。ただし、必ず、ご使用のプログラム言語に合う EPI 定数のシンボル名を使って
コーディングする必要があります。
134
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
EPI 定数およびデータ構造
フィールド長
v CICS_EPI_SYSTEM_MAX (8)
v CICS_EPI_DESCRIPTION_MAX (60)
v CICS_EPI_NETNAME_MAX (8)
v CICS_EPI_TRANSID_MAX (4)
v CICS_EPI_ABEND_MAX (4)
v CICS_EPI_DEVTYPE_MAX (16)
v CICS_EPI_ERROR_MAX (60).
v CICS_EPI_PASSWORD_MAX (10)
v CICS_EPI_USERID_MAX (10)
v CICS_EPI_MAPNAME_MAX (7)
v CICS_EPI_MAPSETNAME_MAX (8)
v CICS_EPI_TERMID_MAX (4)
TermIndex 関連
v CICS_EPI_TERM_INDEX_NONE 0xFFFF
バージョン番号 (「CICS Transaction Gateway: プログラミング・ガイド」の EPI バー
ジョンを参照。)
v CICS_EPI_VERSION_200
EPI データ構造
EPI で使用できるデータ構造は以下のとおりです。
v CICS_EpiSystem_t
v CICS_EpiAttributes_t
v CICS_EpiDetails_t
v CICS_EpiEventData_t
データ構造のフィールド記述でストリングとして記述されているフィールドは、ヌル終
了ストリングです。
CICS_EpiSystem_t:
目的: CICS_EpiSystem_t 構造には、CICS サーバーの名前と記述が含まれています。
これらの構造の配列は、CICS_EpiListSystems 関数から戻されます。
フィールド:
SystemName
CICS サーバーを命名するストリングです。このストリングは、パラメーター
として CICS_EpiAddTerminal および CICS_EpiAddExTerminal 関数に渡し
て、端末リソースをインストールする CICS サーバーを識別することができま
す。名前が CICS_EPI_SYSTEM_MAX 文字より短い場合は、
CICS_EPI_SYSTEM_MAX + 1 の長さまでヌルが埋め込まれます。
第 4 章 C および COBOL
135
EPI 定数およびデータ構造
作成日付: 2005年12月2日
Description
サーバーの要旨を与えるストリングです。記述が
CICS_EPI_DESCRIPTION_MAX より短い場合は、
CICS_EPI_DESCRIPTION_MAX +1 の長さまでヌルが埋め込まれます。
CICS_EpiAttributes_t:
目的: CICS_EpiAttributes_t 構造は、CICS_EpiAddExTerminal 関数によってインス
トールされた端末リソース関連の属性に関する情報を持っています。
フィールド:
EpiAddType
アプリケーションが、端末インストール要求の完了まで待機する準備が整って
いるかどうかを示します。次のいずれかの値を使用します。
CICS_EPI_ADD_ASYNC
呼び出し側のアプリケーションは、端末リソースのインストール要求
が受け入れられると、制御を取り戻します。この時点で、パラメータ
ーの検証が行われます。
パラメーターが有効であれば、端末のインストール要求が完了したと
きに、CICS_EPI_EVENT_ADD_TERM イベントが生成されます。
TermIndex が戻され、CICS_EpiGetEvent 関数で使用されます。
CICS_EPI_ADD_SYNC
呼び出し側のアプリケーションは、端末リソースのインストール要求
が完了すると、制御を取り戻します。戻された情報は、直ちに使用で
きます。
InstallTimeOut
端末リソースのインストールに許される最大時間を、0 から 3600 の範囲の値
の秒数で示します。0 の値は制限が設定されていないことを意味します。
この範囲より大きい値を指定すると、3600 の値が使用されます。
ReadTimeOut
端末リソースに対して CICS_EPI_EVENT_CONVERSE イベントを通知してか
ら、次に CICS_EpiReply を呼び出すまでの間に許される最大時間を、0 から
3600 の範囲の値の秒数で示します。 0 の値は制限が設定されていないことを
意味します。
この範囲より大きい値を指定すると、3600 の値が使用されます。
タイムアウトが起こると、会話は異常終了します。この結果、
CICS_EPI_EVENT_END_TRAN イベントが生成されます。 EndReason フィー
ルドは CICS_EPI_READTIMEOUT_EXPIRED に設定されます。AbendCode フ
ィールドは設定されません。
136
CICS Transaction Gateway: プログラミング・リファレンス
EPI 定数およびデータ構造
作成日付: 2005年12月2日
SignonCapability
アプリケーションが、サーバー提供のサインオンおよびサインオフ・トランザ
クションを端末リソースから開始できるかどうかを示します。次のいずれかの
値を使用します。
CICS_EPI_SIGNON_CAPABLE
端末リソースは、サインオン対応としてインストールされます。
CICS_EPI_SIGNON_INCAPABLE
リソースは、サインオン非対応としてインストールされます。
CCSId
端末リソースと CICS トランザクション間で受け渡されるデータについて、ク
ライアント・アプリケーションが使用するコード化図形文字セットを識別する
コード化文字セット ID (CCSID) を指定した 1 から 65536 までの範囲の値で
す。
0 の値は、デフォルトの CCSID を使用することを意味します。
各種の文字セットの CCSID 値の詳細については、ご使用のオペレーティン
グ・システム用の「CICS Transaction Gateway: 管理」のクライアント・デー
モン使用時のデータ変換を参照してください。
UserId
端末リソースに関連したユーザー ID を指定するストリング。ユーザー ID が
CICS_EPI_USERID_MAX より短い場合は、CICS_EPI_USERID_MAX+1 の長さ
までヌルを埋め込む必要があります。
Password
端末リソースに関連したパスワードを指定するストリング。パスワードが
CICS_EPI_PASSWORD_MAX 文字より短い場合は、
CICS_EPI_PASSWORD_MAX+1 の長さまでヌルを埋め込む必要があります。
CICS_EpiDetails_t:
目的: CICS_EpiDetails_t 構造は、CICS_EpiAddTerminal または
CICS_EpiAddExTerminal 関数によってインストールされた端末リソースに関する情報
を持っています。
フィールド:
NetName
端末リソースの VTAM® スタイルのネット名を指定するストリング。名前が
CICS_EPI_NETNAME_MAX 文字より短い場合は、CICS_EPI_NETNAME_MAX
+ 1 の長さまでヌルが埋め込まれます。
NumLines
端末リソースによってサポートされる行数。
第 4 章 C および COBOL
137
EPI 定数およびデータ構造
作成日付: 2005年12月2日
NumColumns
端末リソースによってサポートされる列数。
MaxData
CICS_EpiStartTran 呼び出しまたは CICS_EpiReply 呼び出しによって、CICS
トランザクションからこの端末リソースに送信できるデータの最大サイズ、お
よびこの端末リソースから CICS トランザクションへ送信できるデータの最大
サイズです。
最大サイズは、端末リソースをサーバーにインストールした
CICS_EpiAddTerminal 呼び出しの DevType パラメーターで指定されたモデル
端末定義で定義することができます。モデル端末定義で値が指定されていない
場合は、デフォルト値の 12000 が使用されます。
ErrLastLine
端末リソースのエラー・メッセージを最後の行に表示する場合は 1、それ以外
の場合は 0。
ErrIntensify
端末リソースがエラー・メッセージを強調表示する場合は 1、それ以外の場合
は 0。
ErrColor
エラー・メッセージの表示に使用する色を定義する 3270 属性。
ErrHilight
エラー・メッセージの表示に使用する強調表示の値を定義する 3270 属性。
Hilight 端末リソースが拡張強調表示をサポートするように定義されている場合は 1、
それ以外の場合は 0。
Color
端末リソースがカラー表示をサポートするように定義されている場合は 1、そ
れ以外の場合は 0。
System 端末リソースがインストールされているサーバーの名前を指定するストリング
です。名前が CICS_EPI_SYSTEM_MAX 文字より短い場合は、
CICS_EPI_SYSTEM_MAX + 1 の長さまでヌルが埋め込まれます。
TermId 端末リソースの名前を指定するストリングです。名前が
CICS_EPI_TERMID_MAX 文字より短い場合は、CICS_EPI_TERMID_MAX + 1
の長さまでヌルが埋め込まれます。
SignonCapability
サーバーによって端末リソースに割り当てられたサインオン機能。
CICS_EPI_SIGNON_CAPABLE
アプリケーションが、端末リソースでサーバー提供のサインオンおよ
びサインオフ・トランザクションを開始できる場合。
138
CICS Transaction Gateway: プログラミング・リファレンス
EPI 定数およびデータ構造
作成日付: 2005年12月2日
CICS_EPI_SIGNON_INCAPABLE
アプリケーションが、端末リソースでサーバー提供のサインオンおよ
びサインオフ・トランザクションを開始できない場合。
CICS_EPI_SIGNON_UNKNOWN
CICS_EpiAddTerminal 関数を使用して、端末リソースを追加した場
合。 (CICS_EpiAddExTerminal 関数を使用して、端末リソースを追
加し、前提変更がサーバーに適用されなかった場合も、この値が戻さ
れます。)
CICS_EpiEventData_t:
目的: CICS_EpiEventData_t 構造は、端末に関連するイベントの詳細を持っていま
す。すべてのイベントに対して全フィールドが有効とは限りません。無効なフィールド
はヌルに設定されます。この構造は、CICS_EpiGetEvent からの出力です。
フィールド:
TermIndex
このイベントが発生した対象の端末リソースの端末索引です。
Event
イベント標識、すなわち、 167 ページの『EPI イベント』にリストされている
イベント・コードの 1 つです。
EndReason
イベントが CICS_EPI_EVENT_END_TERM または
CICS_EPI_EVENT_END_TRAN イベントの場合、終了の理由。
TransId
トランザクション名を指定したストリングです。名前が
CICS_EPI_TRANSID_MAX 文字より短い場合は、この長さまでスペースが埋め
込まれ、その後に 1 つのヌル文字が続きます。
Reserved1
予約フィールド。
CICS Transaction Gateway バージョン 3.1 以前は、このフィールドは
AbendCode と呼ばれていました。
Data
イベントに関連した端末データ・ストリームで更新されるバッファーへのポイ
ンターです。
入力時に Data パラメーターは、非同期的に追加される端末に対する
CICS_EpiGetEvent の最初の呼び出しで、CICS_EpiDetails_t 構造を指すよう
に設定する必要があります。詳細な構造は、CICS_EpiGetEvent から戻ったと
きに更新されます。
第 4 章 C および COBOL
139
EPI 定数およびデータ構造
Size
作成日付: 2005年12月2日
Data によってアドレスされるバッファーの最大サイズです。
CICS_EpiGetEvent 呼び出しから戻ったときには、これには戻されたデータの
実際の長さが入ります。
EndReturnCode
CICS_EPI_returncode を含むストリング。
MapName
イベントが CICS_EPI_EVENT_SEND または CICS_EPI_EVENT_CONVERSE
イベントの場合、端末リソースで処理された SEND MAP コマンドの MAP オ
プションで最後に参照されたマップ名を指定したストリングです。端末リソー
スが BMS でサポートされていない場合、あるいは送信されるマップのレコー
ドがサーバーにない場合は、戻される値はスペースです。名前が
CICS_EPI_MAPNAME_MAX 文字より短い場合は、この長さまでスペースが埋
め込まれ、その後に 1 つのヌル文字が続きます。
MapSetName
イベントが CICS_EPI_EVENT_SEND または CICS_EPI_EVENT_CONVERSE
イベントの場合、端末リソースで処理された SEND MAP コマンドの
MAPSET オプションで最後に参照されたマップ・セット名を指定したストリン
グです。最新の要求で MAPSET オプションが指定されなかった場合は、BMS
はマップ・セット名としてマップ名を使用しています。いずれの場合も、使用
されたマップ・セット名には、端末接尾部が付いていた可能性があります。端
末リソースが BMS でサポートされていない場合、あるいは送信されるマッ
プ・セットのレコードがサーバーにない場合は、戻される値はスペースです。
名前が CICS_EPI_MAPSETNAME_MAX 文字より短い場合は、この長さまでス
ペースが埋め込まれ、その後に 1 つのヌル文字が続きます。
注: Data および Size フィールドは、CICS_EpiGetEvent への呼び出しが行われる前
に、設定しておく必要があります。
EPI 関数
このセクションでは、アプリケーション・プログラムから呼び出すことができる EPI が
提供する関数について説明します。
v CICS_EpiInitialize
v CICS_EpiTerminate
v CICS_EpiListSystems
v CICS_EpiAddTerminal
v CICS_EpiAddExTerminal
v CICS_EpiInquireSystem
v CICS_EpiDelTerminal
v CICS_EpiPurgeTerminal
v CICS_EpiSetSecurity
v CICS_EpiStartTran
140
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
v CICS_EpiReply
v CICS_EpiATIState
v CICS_EpiGetEvent
表 1 は、インターフェースの関数、それぞれの関数に渡されるパラメーター、およびそ
れぞれの関数からの可能な戻りコードを要約しています。
Windows オペレーティング・システムの場合、実際の戻りコード値をシンボル名にマッ
ピングしたものが、次のファイルに含まれています。
C
\include\cics_eci.h
Cobol
\copybook\cicsepi.cbl
UNIX および Linux オペレーティング・システムの場合は、次のファイルです。
C
/include/cics_eci.h
表 1. EPI 関数の要約
関数名
パラメーター
戻りコード: CICS_EPI_
CICS_EpiInitialize
Version
ERR_FAILED
ERR_IS_INIT
ERR_VERSION
NORMAL
CICS_EpiTerminate
なし
ERR_FAILED
ERR_NOT_INIT
ERR_IN_CALLBACK
NORMAL
CICS_EpiListSystems
NameSpace
Systems
List
ERR_FAILED
ERR_MORE_SYSTEMS
ERR_NO_SYSTEMS
ERR_NOT_INIT
ERR_NULL_PARM
ERR_IN_CALLBACK
NORMAL
第 4 章 C および COBOL
141
EPI 関数
作成日付: 2005年12月2日
表 1. EPI 関数の要約 (続き)
142
関数名
パラメーター
戻りコード: CICS_EPI_
CICS_EpiAddTerminal
NameSpace
System
Netname
DevType
NotifyFn
Details
TermIndex
ERR_ALREADY_INSTALLED
ERR_FAILED
ERR_IN_CALLBACK
ERR_MAX_SESSIONS
ERR_MAX_SYSTEMS
ERR_MODELID_INVALID
ERR_NOT_3270_DEVICE
ERR_NOT_INIT
ERR_NULL_PARM
ERR_RESOURCE_SHORTAGE
ERR_SECURITY
ERR_SERVER_BUSY
ERR_SERVER_DOWN
ERR_SYSTEM
ERR_TERMID_INVALID
NORMAL
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
表 1. EPI 関数の要約 (続き)
関数名
パラメーター
戻りコード: CICS_EPI_
CICS_EpiAddExTerminal
System
Netname
DevType
NotifyFn
Details
TermIndex
Attributes
ERR_FAILED
ERR_NOT_INIT
ERR_SYSTEM
ERR_SECURITY
ERR_NULL_PARM
ERR_VERSION
ERR_IN_CALLBACK
ERR_SERVER_DOWN
ERR_RESPONSE_TIMEOUT
ERR_SIGNON_NOT_POSS
ERR_PASSWORD_INVALID
ERR_ADDTYPE_INVALID
ERR_SIGNONCAP_INVALID
ERR_USERID_INVALID
ERR_TERMID_INVALID
ERR_MODELID_INVALID
ERR_NOT_3270_DEVICE
ERR_ALREADY_INSTALLED
ERR_CCSID_INVALID
ERR_SERVER_BUSY
ERR_RESOURCE_SHORTAGE
ERR_MAX_SESSIONS
ERR_MAX_SYSTEMS
NORMAL
CICS_EpiInquireSystem
TermIndex
System
ERR_BAD_INDEX
ERR_FAILED
ERR_NOT_INIT
ERR_NULL_PARM
ERR_IN_CALLBACK
NORMAL
CICS_EpiDelTerminal
TermIndex
ERR_BAD_INDEX
ERR_FAILED
ERR_NOT_INIT
ERR_TRAN_ACTIVE
ERR_IN_CALLBACK
NORMAL
第 4 章 C および COBOL
143
EPI 関数
作成日付: 2005年12月2日
表 1. EPI 関数の要約 (続き)
144
関数名
パラメーター
戻りコード: CICS_EPI_
CICS_EpiPurgeTerminal
TermIndex
ERR_BAD_INDEX
ERR_FAILED
ERR_NOT_INIT
ERR_IN_CALLBACK
ERR_VERSION
NORMAL
CICS_EpiSetSecurity
TermIndex
UserId
Password
ERR_NOT_INIT
ERR_BAD_INDEX
ERR_IN_CALLBACK
ERR_SYSTEM_ERROR
ERR_VERSION
ERR_PASSWORD_INVALID
ERR_USERID_INVALID
ERR_NULL_PASSWORD
ERR_NULL_USERID
NORMAL
CICS_EpiStartTran
TermIndex
TransId
Data
Size
ERR_ATI_ACTIVE
ERR_BAD_INDEX
ERR_FAILED
ERR_NO_DATA
ERR_NOT_INIT
ERR_TTI_ACTIVE
ERR_IN_CALLBACK
ERR_SERVER_DOWN
ERR_RESOURCE_SHORTAGE
ERR_MAX_SESSIONS
NORMAL
CICS_EpiReply
TermIndex
Data
Size
ERR_BAD_INDEX
ERR_FAILED
ERR_NO_CONVERSE
ERR_NO_DATA
ERR_NOT_INIT
ERR_IN_CALLBACK
ERR_ABENDED
ERR_SERVER_DOWN
NORMAL
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
表 1. EPI 関数の要約 (続き)
関数名
パラメーター
戻りコード: CICS_EPI_
CICS_EpiATIState
TermIndex
ATIState
ERR_ATI_STATE
ERR_BAD_INDEX
ERR_FAILED
ERR_NOT_INIT
ERR_IN_CALLBACK
ERR_NULL_PARAM
NORMAL
CICS_EpiGetEvent
TermIndex
Wait
ERR_BAD_INDEX
ERR_FAILED
ERR_MORE_DATA
ERR_MORE_EVENTS
ERR_NO_EVENT
ERR_NOT_INIT
ERR_WAIT
ERR_NULL_PARAM
ERR_IN_CALLBACK
NORMAL
CICS_GetSysError
TermIndex
SysErr
ERR_NOT_INIT
ERR_BAD_INDEX
ERR_FAILED
ERR_NULL_PARAM
ERR_VERSION
NORMAL
パラメーターのタイプと使用法、関数が使用するデータ構造、および戻りコードの意味
については、それぞれの関数の定義を参照してください。
CICS_EpiInitialize
CICS_EpiInitialize
Version
目的: CICS_EpiInitialize 関数は EPI を初期化します。このアプリケーションからの
他の EPI 呼び出しは、この呼び出しが行われる前は、すべて無効です。
パラメーター:
Version
アプリケーションのコーディングに対応する EPI のバージョンです。これによ
って、古いアプリケーションでも EPI の将来のバージョンに対して互換性を維
第 4 章 C および COBOL
145
EPI 関数
作成日付: 2005年12月2日
持することができます。ここで記述されているバージョンは、
CICS_EPI_VERSION_200 です。詳細については、「CICS Transaction
Gateway: プログラミング・ガイド」の EPI versions を参照してください。
EPI は、このパラメーターを入力用のみに使用します。
戻りコード:
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_IS_INIT
EPI はすでに初期化されています。
CICS_EPI_ERR_VERSION
EPI は、要求されたバージョンをサポートできません。
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiTerminate
CICS_EpiTerminate
目的: CICS_EpiTerminate 関数は、(通常は、アプリケーションの終了直前に) アプリ
ケーションでの EPI の使用を終了させます。この呼び出しが完了した後は、他のすべて
の EPI 呼び出し (CICS_EpiInitialize を除く) は、無効になります。
アプリケーションは終了する前に CICS_EpiDelTerminal 呼び出しを行って、端末リソ
ースを削除する必要があります。
パラメーター: なし
戻りコード:
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_TTI_ACTIVE
EPI から開始されたトランザクションはまだアクティブのままです。あるい
は、CICS_EpiGetEvent 呼び出しが依然として未解決です。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
146
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiListSystems
CICS_EpiListSystems
NameSpace
Systems
List
目的: CICS_EpiListSystems 関数は、EPI 要求用のサーバーとしての役割を果たす候
補である CICS サーバーのリストを戻します。 CICS Transaction Gateway とリスト上
のいずれかのサーバー間に通信リンクが存在する保証も、いずれかのサーバーが要求を
処理できる保証もありません。
リストは、それぞれの CICS サーバーごとに 1 つのエレメントで、システム情報の構
造の配列として戻されます。構造の内容については 135 ページの『CICS_EpiSystem_t』
を参照してください。
EPI アプリケーションは、それぞれの CICS_EpiInitialize 呼び出しを行った直後にこの
関数を呼び出して、使用可能な CICS サーバーを判別する必要があります。
パラメーター:
NameSpace
将来使用するために予約済みのポインターです。これは、ヌル・ポインターで
なければなりません。
Systems
数値を指すポインターです。この数値は、関数への入力時に List パラメータ
ーで指定する配列のエレメント数を指定します。この値は、EPI が結果を保管
するために使用できるストレージの量を正確に反映するものでなければなりま
せん。戻り時には、検出された実際のサーバー数が入っています。
EPI は、このパラメーターを入出力の両方で使用します。
List
関数によって入力され、戻される CICS_EpiSystem_t 構造の配列です。アプリ
ケーションは、配列用にストレージを用意して、Systems パラメーターが配列
のエレメント数を示すように設定する必要があります。リストの最初の名前
は、デフォルトのサーバーです。ただし、デフォルトを定義する方法は、オペ
レーティング・システムによって異なります。
EPI は、このパラメーターを出力用のみに使用します。
戻りコード:
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
第 4 章 C および COBOL
147
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_MORE_SYSTEMS
List 配列のスペースが不足しているため、検出されたすべての CICS サーバー
の詳細情報を保管できませんでした。指定された配列は全部埋まっており、
Systems パラメーターは検出されたサーバーの総数が入るように更新されまし
た。これによって、配列を適切なサイズに再割り振りして、関数を再試行する
ことができます。
CICS_EPI_ERR_NO_SYSTEMS
CICS サーバーが見つかりません。この場合、Systems に戻される値はゼロで
す。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_NULL_PARM
Systems がヌル・ポインターです。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_NORMAL
関数が正常に完了しました。検出されたシステムの数は少なくとも 1 つであ
り、Systems パラメーターで入力として指定された値を超えていません。
CICS_EpiAddTerminal
CICS_EpiAddTerminal
NameSpace
System
NetName
DevType
NotifyFn
Details
TermIndex
目的: CICS_EpiAddTerminal 関数は、アプリケーションで使用するための、新しい端
末リソースのインストール、あるいは既存の端末リソースの予約を行います。この関数
は、端末索引を提供します。この端末索引は、これ以降すべての EPI 呼び出しで端末リ
ソースの識別に使用する必要があります。また、この関数は、CICS_EpiDetails_t デー
タ構造で定義された情報も提供します。
この操作で追加できる端末の数には、次のような制限があります。つまり、その最大数
はクライアント・システムで使用可能なリソースによって異なるというものです。
148
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
注: CICS_EpiAddTerminal 関数は、端末リソースがインストールされているサーバー上
に、サインオン機能が依存している端末リソースを追加します。たとえば、CICS
Transaction Server の z/OS サーバー版の場合、端末リソースにはサインオン機能は
ありません。
パラメーター:
NameSpace
将来使用するために予約済みのポインターです。これは、ヌル・ポインターで
なければなりません。
System
端末リソースのインストールまたは予約を行うサーバーの名前を指定したヌル
終了ストリングへのポインターです。名前が CICS_EPI_SYSTEM_MAX 文字よ
り短い場合は、CICS_EPI_SYSTEM_MAX + 1 の長さまでヌルを埋め込む必要
があります。
このストリングがすべてヌルの場合は、デフォルト・サーバーは EPI によって
選択されます。選択されたサーバーの名前を判別するには、
CICS_EpiInquireSystem を使用します。
EPI は、このパラメーターを入力用のみに使用します。
NetName
インストールまたは予約しておく端末リソースの名前を指定したヌル終了スト
リングへのポインター、もしくはヌルです。この名前の変換処理は、サーバー
によって異なります。
ストリングの指定が CICS_EPI_NETNAME_MAX より短い場合は、
CICS_EPI_NETNAME_MAX + 1 の長さまでヌルを埋め込む必要があります。
このストリングは、大文字に変換されずにサーバーへ送信されます。
使用される文字は、クライアントのコード・ページから EBCDIC コード・ペ
ージへ、送信する前に変換されます。サーバーが ASCII コード・ページを使
用している場合は、文字は再変換されます。この変換において不変であること
が保証されている文字は、大文字の A から Z と数字の 0 から 9 だけです。
一部の EBCDIC サーバー (カタカナおよびヘブライ語文字セット A) では、英
小文字の標準表記を使用していません。したがって、そのようなサーバーとの
通信では、英小文字の使用には注意してください。
NetName の用途は以下のとおりです。
1. 名前が NetName を使用して指定された場合、かつ、それがサーバーの既存
の端末リソースの名前と一致した場合、サーバーはその端末リソースを予約
しようとします。
2. 名前は指定されてもサーバーの既存の端末リソースの名前と一致しない場合
は、サーバーは、この後説明する DevType パラメーターで指定されたモデ
ル端末定義を使用して端末リソースをインストールし、それに入力名を付け
第 4 章 C および COBOL
149
EPI 関数
作成日付: 2005年12月2日
ます。 (DevType がヌル・ポインターの場合は、CICS_EPI_VERSION_200
以降では、CICS_EPI_ERR_TERMID_INVALID が戻されます。それ以外で
は、CICS_EPI_ERR_FAILED が戻されます。)
3. NetName がヌル・ポインターの場合は、DevType で指定されたモデル端末
定義を使用して、端末リソースがインストールされます。 DevType がヌ
ル・ポインターの場合は、選択される端末タイプは予測できないため、整合
性のある結果を確保するために DevType の使用をお勧めします。端末リソ
ースの名前は、CICS_EpiDetails_t 構造の NetName フィールドにありま
す。
EPI は、このパラメーターを入力用のみに使用します。
DevType
端末リソース定義を生成するモデル端末定義を選択するために、サーバーで使
用するヌル終了ストリングへのポインター、もしくはヌル・ポインターです。
ストリングの指定が CICS_EPI_DEVTYPE_MAX より短い場合は、
CICS_EPI_DEVTYPE_MAX + 1 の長さまでヌルを埋め込む必要があります。
このストリングは、大文字に変換されずにサーバーへ送信されます。
使用される文字は、クライアントのコード・ページから EBCDIC コード・ペ
ージへ、送信する前に変換されます。サーバーが ASCII コード・ページを使
用している場合は、文字は再変換されます。この変換において不変であること
が保証されている文字は、大文字の A から Z と数字の 0 から 9 だけです。
一部の EBCDIC サーバー (カタカナおよびヘブライ語文字セット A) では、英
小文字の標準表記を使用していません。したがって、そのようなサーバーとの
通信では、英小文字の使用には注意してください。
EPI は、このパラメーターを入力用のみに使用します。
NotifyFn
ATI 要求の到着など、端末リソースでイベントが発生すると常に呼び出される
コールバック・ルーチンへのポインターです。コールバック・ルーチンが必要
ない場合は、このパラメーターはヌルに設定します。
EPI は、このパラメーターを入力用のみに使用します。
Details
インストールまたは予約された端末リソースに関する各種の詳細情報が、戻さ
れる際に含まれている CICS_EpiDetails_t 構造へのポインターです。
EPI は、この構造のフィールドを出力用のみに使用します。
TermIndex
インストールまたは予約されたばかりの端末リソースの端末索引へのポインタ
ーです。戻された端末索引は、これ以降のすべての EPI 関数呼び出しへの入力
として使用し、関数の対象である端末リソースを識別する必要があります。指
定された端末索引は、最初に使用可能な整数であり、0 から始まります。
150
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
EPI は、このパラメーターを出力用のみに使用します。
戻りコード:
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_SYSTEM
指定されたサーバーは、クライアントでは認識されません。
CICS_EPI_ERR_SECURITY
セキュリティー上の理由により、サーバーは試行をリジェクトしました。
CICS_EPI_ERR_NULL_PARM
TermIndex はヌル・ポインターでした。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_ERR_SERVER_DOWN
サーバーがダウンしたために、関数が失敗しました。
CICS_EPI_ERR_TERMID_INVALID
無効な TermId が指定されたため、関数が失敗しました。
CICS_EPI_ERR_MODELID_INVALID
無効なモデル端末定義が指定されたため、関数は失敗しました。
CICS_EPI_ERR_NOT_3270_DEVICE
指定された装置タイプが 3270 装置用ではなかったため、関数は失敗しまし
た。
CICS_EPI_ERR_ALREADY_INSTALLED
端末がすでにインストール済みであったため、関数は失敗しました。
CICS_EPI_ERR_SERVER_BUSY
サーバーが使用中のために、関数が失敗しました。
CICS_EPI_ERR_RESOURCE_SHORTAGE
CICS サーバーまたは CICS Transaction Gateway は、端末のインストールを完
了するのに十分なリソースがありませんでした。
CICS_EPI_ERR_MAX_SESSIONS
MAXREQUESTS の制限を超えました。
CICS_EPI_ERR_MAX_SYSTEMS
構成で許可されている数以上のサーバーに対して、接続を開始しようとしまし
た。
第 4 章 C および COBOL
151
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiAddExTerminal
CICS_EpiAddExTerminal
System
NetName
DevType
NotifyFn
Details
TermIndex
Attributes
目的: CICS_EpiAddExTerminal 関数は、アプリケーションで使用するための、新しい
端末リソースのインストール、または既存の端末リソースの予約を行います。この関数
は、端末索引を提供します。この端末索引は、これ以降すべての EPI 呼び出しで端末リ
ソースの識別に使用する必要があります。また、この関数は、CICS_EpiDetails_t デー
タ構造で定義された情報も提供します。
属性によっては (たとえば、3270 データで使用する文字セットとエンコード・スキー
ム、およびサインオン機能など)、アプリケーションによって決定されるものもありま
す。このような属性は、CICS_EpiAttributes_t 構造の CCSID および SignonCapability
フィールドで指定されています。
パラメーター:
System
端末リソースのインストールまたは予約を行うサーバーの名前を指定したヌル
終了ストリングへのポインターです。名前が CICS_EPI_SYSTEM_MAX 文字よ
り短い場合は、CICS_EPI_SYSTEM_MAX + 1 の長さまでヌルを埋め込む必要
があります。
このストリングがすべてヌルの場合は、デフォルト・サーバーは EPI によって
選択されます。選択されたサーバーの名前を判別するには、
CICS_EpiInquireSystem を使用します。
EPI は、このパラメーターを入力用のみに使用します。
NetName
インストールまたは予約しておく端末リソースの名前を指定したヌル終了スト
リングへのポインター、もしくはヌルです。この名前の変換処理は、サーバー
によって異なります。
ストリングの指定が CICS_EPI_NETNAME_MAX より短い場合は、
CICS_EPI_NETNAME_MAX + 1 の長さまでヌルを埋め込む必要があります。
152
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
このストリングは、大文字に変換されずにサーバーへ送信されます。
使用される文字は、クライアントのコード・ページから EBCDIC コード・ペ
ージへ、送信する前に変換されます。サーバーが ASCII コード・ページを使
用している場合は、文字は再変換されます。この変換において不変であること
が保証されている文字は、大文字の A から Z と数字の 0 から 9 だけです。
一部の EBCDIC サーバー (カタカナおよびヘブライ語文字セット A) では、英
小文字の標準表記を使用していません。したがって、そのようなサーバーとの
通信では、英小文字の使用には注意してください。
NetName の用途は以下のとおりです。
1. 名前が NetName を使用して指定された場合、かつ、それがサーバーの既存
の端末リソースの名前と一致した場合、サーバーはその端末リソースを予約
しようとします。
2. 名前は指定されてもサーバーの既存の端末リソースの名前と一致しない場合
は、サーバーは、この後説明する DevType パラメーターで指定されたモデ
ル端末定義を使用して端末リソースをインストールし、それに入力名を付け
ます。 (DevType がヌル・ポインターの場合は、CICS_EPI_VERSION_200
以降では、CICS_EPI_ERR_TERMID_INVALID が戻されます。それ以外で
は、CICS_EPI_ERR_FAILED が戻されます。)
3. NetName がヌル・ポインターの場合は、DevType で指定されたモデル端末
定義を使用して、端末リソースがインストールされます。 DevType がヌ
ル・ポインターの場合は、選択される端末タイプは予測できないため、整合
性のある結果を確保するために DevType の使用をお勧めします。端末リソ
ースの名前は、CICS_EpiDetails_t 構造の NetName フィールドにありま
す。
EPI は、このパラメーターを入力用のみに使用します。
DevType
端末リソース定義を生成するモデル端末定義を選択するために、サーバーで使
用するヌル終了ストリングへのポインター、もしくはヌル・ポインターです。
ストリングの指定が CICS_EPI_DEVTYPE_MAX より短い場合は、
CICS_EPI_DEVTYPE_MAX + 1 の長さまでヌルを埋め込む必要があります。
このストリングは、大文字に変換されずにサーバーへ送信されます。
使用される文字は、クライアントのコード・ページから EBCDIC コード・ペ
ージへ、送信する前に変換されます。サーバーが ASCII コード・ページを使
用している場合は、文字は再変換されます。この変換において不変であること
が保証されている文字は、大文字の A から Z と数字の 0 から 9 だけです。
一部の EBCDIC サーバー (カタカナおよびヘブライ語文字セット A) では、英
小文字の標準表記を使用していません。したがって、そのようなサーバーとの
通信では、英小文字の使用には注意してください。
第 4 章 C および COBOL
153
EPI 関数
作成日付: 2005年12月2日
EPI は、このパラメーターを入力用のみに使用します。
NotifyFn
ATI 要求の到着など、端末リソースでイベントが発生すると常に呼び出される
コールバック・ルーチンへのポインターです。コールバック・ルーチンが必要
ない場合は、このパラメーターはヌルに設定します。
EPI は、このパラメーターを入力用のみに使用します。
Details
インストールまたは予約された端末リソースに関する各種の詳細情報が、戻さ
れる際に含まれている CICS_EpiDetails_t 構造へのポインターです。非同期呼
び出しの場合は、Details パラメーターはヌルに設定する必要があります。ポイ
ンターがヌルに設定されていない場合は、端末リソースのインストールが完了
すると、詳細情報が構造に追加されます。非同期呼び出しの場合は、これは
CICS_EPI_EVENT_ADD_TERM イベントが発生すると行われます。
EPI は、この構造のフィールドを出力用のみに使用します。
TermIndex
インストールまたは予約されたばかりの端末リソースの端末索引へのポインタ
ーです。戻された端末索引は、これ以降のすべての EPI 関数呼び出しへの入力
として使用し、関数の対象である端末リソースを識別する必要があります。指
定された端末索引は、最初に使用可能な整数であり、0 から始まります。
EPI は、このパラメーターを出力用のみに使用します。
Attributes
インストールされる端末リソースのクライアント・アプリケーションによって
定義できる属性を指定する CICS_EpiAttributes_t 構造へのポインターです。
この構造は、使用する前に、ヌルに設定しておく必要があります。
ポインターをヌルに設定した場合は、デフォルトの属性が使用されます。
EPI は、このパラメーターを入力用のみに使用します。
戻りコード:
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_SYSTEM
指定されたサーバーは、CICS Transaction Gateway では認識されません。
CICS_EPI_ERR_SECURITY
セキュリティー上の理由により、サーバーは試行をリジェクトしました。
154
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_NULL_PARM
TermIndex がヌル・ポインターでした。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_ERR_RESPONSE_TIMEOUT
指定されたインターバル内に、サーバーからの応答はありませんでした。
CICS_EPI_ERR_SIGNON_NOT_POSS
サーバーは、端末リソースをサインオン対応としてインストールすることは許
可していません。
CICS_EPI_ERR_SERVER_DOWN
サーバーがダウンしたために、関数が失敗しました。
CICS_EPI_ERR_PASSWORD_INVALID
パスワードの長さが CICS_EPI_PASSWORD_MAX を超えています。
CICS_EPI_ERR_ADDTYPE_INVALID
CICS_EpiAttributes_t 構造の EpiAddType フィールドに割り当てられた値
が、CICS_EPI_ADD_ASYNC でも CICS_EPI_ADD_SYNC でもありません。
CICS_EPI_ERR_SIGNONCAP_INVALID
CICS_EpiAttributes_t 構造の SignonCapability フィールドに割り当てられた値
が、CICS_EPI_SIGNON_CAPABLE でも CICS_EPI_SIGNON_INCAPABLE で
もありません。
CICS_EPI_ERR_USERID_INVALID
ユーザー ID の長さが CICS_EPI_USERID_MAX を超えています。
CICS_EPI_ERR_TERMID_INVALID
無効な TermId が指定されたため、関数が失敗しました。
CICS_EPI_ERR_MODELID_INVALID
無効なモデル端末定義が指定されたため、関数は失敗しました。
CICS_EPI_ERR_NOT_3270_DEVICE
指定された装置タイプが 3270 装置用ではなかったため、関数は失敗しまし
た。
CICS_EPI_ERR_ALREADY_INSTALLED
端末がすでにインストール済みであったため、関数は失敗しました。
CICS_EPI_ERR_CCSID_INVALID
無効な CCSID が指定されたため、関数が失敗しました。
各種の文字セットの CCSID 値の詳細については、ご使用のオペレーティン
グ・システム用の「CICS Transaction Gateway: 管理」のクライアント・デー
モン使用時のデータ変換を参照してください。
第 4 章 C および COBOL
155
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_SERVER_BUSY
サーバーが使用中のために、関数が失敗しました。
CICS_EPI_ERR_VERSION
この関数は、EPI が初期化されたバージョンではサポートされません。
CICS_EPI_ERR_RESOURCE_SHORTAGE
CICS サーバーまたは CICS Transaction Gateway は、端末のインストールを完
了するのに十分なリソースがありませんでした。
CICS_EPI_ERR_MAX_SESSIONS
通信リソースが十分ではないため、この要求を満たすことができませんでし
た。
CICS_EPI_ERR_MAX_SYSTEMS
構成で許可されている数以上のサーバーに対して、接続を開始しようとしまし
た。
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiInquireSystem
CICS_EpiInquireSystem
TermIndex
System
目的: CICS_EpiInquireSystem 関数は、指定された端末リソース (その端末索引によ
り識別) をインストールするサーバーの名前を戻します。
パラメーター:
TermIndex
端末リソースの端末索引。端末リソースの位置を判別します。
EPI は、このパラメーターを入力用のみに使用します。
System サーバー名が戻される、長さが CICS_ECI_SYSTEM_MAX + 1 のストリング
へのポインター。
EPI は、このパラメーターを出力用のみに使用します。
戻りコード:
CICS_EPI_ERR_BAD_INDEX
TermIndex 値は有効な端末索引ではありません。
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
156
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_NULL_PARM
System がヌル・ポインターでした。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_NORMAL
関数が正常に完了しました。サーバー名は、CICS_EPI_SYSTEM_MAX +1 の
長さまでヌルで埋め込まれて、System パラメーターに戻されました。
CICS_EpiDelTerminal
CICS_EpiDelTerminal
TermIndex
目的: CICS_EpiDelTerminal は、以前に追加された端末リソースを削除します。アプ
リケーションは、対応する CICS_EPI_EVENT_END_TERM イベントを受信するまで
は、削除が完了したと見なさないでください。端末索引は、CICS_EpiGetEvent 呼び出
しが CICS_EPI_EVENT_END_TERM イベントを取得するまで、割り振られたままにな
っています。現在、端末リソースがトランザクションを実行中の場合は、この関数の呼
び出しは失敗します。端末リソースが削除されたことを確認するために、アプリケーシ
ョンは CICS_EpiDelTerminal 呼び出しを出す前に、現行のトランザクションが完了
し、未解決のイベントがすべて処理されるまで待っている必要があります。
端末リソースが自動インストールされている場合は、その定義はサーバーから削除され
ます。端末リソースに対する CICS_EpiDelTerminal 呼び出しが正常に完了しても、ア
プリケーションが対応する CICS_EPI_EVENT_END_TERM イベントを受け取るまで
は、端末索引の使用は CICS_EpiGetEvent 呼び出しに制限されます。
パラメーター:
TermIndex
削除される端末リソースの端末索引です。
EPI は、このパラメーターを入力用のみに使用します。
戻りコード:
CICS_EPI_ERR_BAD_INDEX
TermIndex 値は有効な端末索引ではありません。
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
第 4 章 C および COBOL
157
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_TRAN_ACTIVE
現在、トランザクションは端末リソースと対立して実行しているか、またはそ
の端末リソースに関する未処理のイベントがあります。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiPurgeTerminal
CICS_EpiPurgeTerminal
TermIndex
目的: CICS_EpiPurgeTerminal は、以前に追加された端末リソースをパージします。
アプリケーションは、対応する CICS_EPI_EVENT_END_TERM イベントを受信するま
では、削除が完了したと見なさないでください。
CICS_EpiPurgeTerminal 呼び出しが CICS_EpiDelTerminal 呼び出しと異なる点は、ア
プリケーションは、現行のトランザクションが完了するまで待つ必要がないこと、ある
いは呼び出しを行う前にすべての未解決のイベントを処理する必要がないことです。
端末リソースが自動インストールされている場合は、その定義はサーバーから削除され
ます。
このパージ関数は、端末に対して待機している ATI 要求は取り消しません。
パラメーター:
TermIndex
削除される端末リソースの端末索引です。
EPI は、このパラメーターを入力用のみに使用します。
戻りコード:
CICS_EPI_ERR_BAD_INDEX
TermIndex 値は有効な端末索引ではありません。
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
158
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_VERSION
この関数は、EPI が初期化されたバージョンではサポートされません。
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiSetSecurity
CICS_EpiSetSecurity
TermIndex
UserId
Password
目的:
CICS_EpiSetSecurity 関数によって、クライアント・アプリケーションはユーザー ID
とパスワードを指定し、これらをサインオン非対応として以前にインストールされた端
末リソースと関連づけることができます。
CICS_EpiSetSecurity 関数は、いつでも呼び出すことができます。それ以降、同じ端末
リソースに対するトランザクションを開始する場合は、そのユーザー ID とパスワード
を使用します。端末リソースに対して関数が呼び出されなかった場合、もしくは呼び出
されたがユーザー ID と暗黙的にパスワードがヌルに設定されていた場合は、CICS
Transaction Gateway が決めたユーザー ID とパスワードが使用されます。
クライアント・アプリケーションは、ユーザー ID とパスワードを検査する責任がある
ことに注意してください。
パラメーター:
TermIndex
端末リソースの端末索引です。
EPI は、このパラメーターを入力用のみに使用します。
UserId
ユーザー ID を指定するヌル終了ストリングへのポインターです。ユーザー
ID が CICS_EPI_USERID_MAX 文字より短い場合は、
CICS_EPI_USERID_MAX+1 の長さまでヌルを埋め込む必要があります。
EPI は、このパラメーターを入力用のみに使用します。
Password
パスワードを指定するヌル終了ストリングへのポインターです。パスワードが
CICS_EPI_PASSWORD_MAX 文字より短い場合は、
CICS_EPI_PASSWORD_MAX+1 の長さまでヌルを埋め込む必要があります。
EPI は、このパラメーターを入力用のみに使用します。
第 4 章 C および COBOL
159
EPI 関数
作成日付: 2005年12月2日
戻りコード:
CICS_EPI_ERR_BAD_INDEX
TermIndex 値は有効な端末索引ではありません。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_ERR_SYSTEM_ERROR
内部システム・エラーが発生しました。
CICS_EPI_ERR_VERSION
この関数は、EPI が初期化されたバージョンではサポートされません。
CICS_EPI_ERR_NULL_PASSWORD
Password がヌル・ポインターでした。
CICS_EPI_ERR_NULL_USERID
Userid がヌル・ポインターでした。
CICS_EPI_ERR_PASSWORD_INVALID
パスワードの長さが CICS_EPI_PASSWORD_MAX を超えています。
CICS_EPI_ERR_USERID_INVALID
ユーザー ID の長さが CICS_EPI_USERID_MAX を超えています。
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiStartTran
目的:
CICS_EpiStartTran
TermIndex
TransId
Data
Size
CICS_EpiStartTran 関数は、端末リソースから新規トランザクションの開始、または疑
似会話の継続を行います。
v 新規トランザクションの開始 - CICS_EpiAddTerminal の後でこれを行います。ある
いは、前のトランザクションが端末リソースからの次の入力を処理するトランザクシ
ョンを指定しなかったことを CICS_EPI_EVENT_END_TRAN イベントが示した後
で、これを行います。
160
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
v 疑似会話の継続 - 前に指定したトランザクションが、端末リソースからの次の入力を
処理するトランザクションを指定したことを CICS_EPI_EVENT_END_TRAN イベン
トが示した後で、これを行います。
呼び出しが成功した場合は、トランザクションが終了するまで、この端末リソースに対
する開始要求をこれ以上出すことはできません。このことは、
CICS_EPI_EVENT_END_TRAN イベントによって示されます。
パラメーター:
TermIndex
トランザクションを実行する端末リソースの端末索引。
EPI は、このパラメーターを入力用のみに使用します。
TransId
実行するトランザクションを指定したストリングへのポインター、またはヌ
ル・ポインターです。新規のトランザクションを開始する際、この入力がヌ
ル・ポインターの場合は、トランザクション名は Data パラメーターで指定さ
れたデータ・ストリームから取り出します。疑似会話を継続する際にポインタ
ーがヌルではない場合、このストリングは、この端末リソースに対する前の
CICS_EPI_EVENT_END_TRAN イベントで戻されるトランザクション名でなけ
ればなりません。ポインターがヌル以外で、ストリングが
CICS_EPI_TRANSID_MAX 文字より短い場合は、この長さまでスペースを埋め
込む必要があります。
EPI は、このパラメーターを入力用のみに使用します。
Data
トランザクションに関連した 3270 データ・ストリームへのポインター。デー
タ・ストリームは少なくとも 1 つの AID バイトを含んでいる必要があるた
め、このパラメーターは、ヌル・ポインターであってはなりません。
新規のトランザクションを開始する際に TransId パラメーターがヌル・ポイン
ターの場合は、このデータ・ストリームは、少なくとも 4 バイトの長さが必要
であり、しかも、開始するトランザクション名を持っている必要があります。
さらに、最初の EXEC CICS RECEIVE コマンドでトランザクションに渡され
るデータを含んでいることもあります。
新規のトランザクションを開始する際に、TransId パラメーターがヌル・ポイ
ンターではない場合は、データ・ストリームは、1 バイトのみ (AID バイト)、
3 バイト (AID バイトおよびカーソル・アドレス)、あるいは 4 バイト以上
(AID バイト、カーソル・アドレス、データおよび SBA コマンド) になりま
す。最後のケースの場合、データは、最初の EXEC CICS RECEIVE コマンド
で、トランザクション・プログラムに渡されます。
疑似会話が継続する場合は、データ・ストリームは、1 バイトのみ (AID バイ
ト) 、3 バイト (AID バイトおよびカーソル・アドレス)、あるいは 4 バイト
以上 (AID バイト、カーソル・アドレス、データおよび SBA コマンド) にな
第 4 章 C および COBOL
161
EPI 関数
作成日付: 2005年12月2日
ります。最後のケースの場合、データは、最初の EXEC CICS RECEIVE コマ
ンドで、トランザクション・プログラムに渡されます。
CICS の 3270 データ・ストリーム形式の詳細については、「CICS Transaction
Gateway: プログラミング・ガイド」の EPI 用 3270 データ・ストリームを参
照してください。
端末リソースが CICS_EpiAddTerminal を指定してインストールされている場
合は、3270 データ・ストリームの長さは、CICS_EpiDetails_t の MaxData の
値を超えてはなりません。
EPI は、このパラメーターを入力用のみに使用します。
Size
トランザクションに渡される最初のデータのサイズ (バイト) です。
EPI は、このパラメーターを入力用のみに使用します。
注: アプリケーションが、トランザクションを開始するための端末リソースが解放され
ていると判断した場合でも、CICS_EpiStartTran 呼び出しから予期しない戻りコー
ド (CICS_EPI_ERR_ATI_ACTIVE) を得ることがあります。このようなことが起こっ
た場合は、これは、EPI が端末リソースに対して ATI 要求を開始して、対応する
CICS_EPI_EVENT_START_ATI イベントを出したが、アプリケーションは、
CICS_EpiGetEvent 呼び出しを出すことによってイベントをまだ取り出していない
ということを意味しています。
戻りコード:
CICS_EPI_ERR_ATI_ACTIVE
この端末リソースに対して、ATI トランザクションはアクティブです。
CICS_EPI_ERR_BAD_INDEX
TermIndex 値は有効な端末索引ではありません。
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_NO_DATA
最初のデータが与えられませんでした。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_TTI_ACTIVE
EPI から開始されたトランザクションは、この端末リソースですでにアクティ
ブです。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_ERR_SERVER_DOWN
サーバーがダウンしたために、関数が失敗しました。
162
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_RESOURCE_SHORTAGE
CICS サーバーまたは CICS Transaction Gateway は、端末のインストールを完
了するのに十分なリソースがありませんでした。
CICS_EPI_ERR_MAX_SESSIONS
通信リソースが十分ではないため、この要求を満たすことができませんでし
た。
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiReply
CICS_EpiReply
TermIndex
Data
Size
目的: CICS_EpiReply 関数は、端末リソースから CICS トランザクションにデータを
送信します。これは、CICS_EPI_EVENT_CONVERSE イベントへの応答の場合のみ、実
行してください。
パラメーター:
TermIndex
データが送信される端末リソースの端末索引です。
EPI は、このパラメーターを入力用のみに使用します。
Data
トランザクションに送信される 3270 データ・ストリームへのポインター。デ
ータ・ストリームは少なくとも 1 つの AID バイトを含んでいる必要があるた
め、このパラメーターは、ヌル・ポインターであってはなりません。データ・
ストリームは、1 バイト (AID バイト) 、3 バイト (AID バイトおよびカーソ
ル・アドレス)、あるいは 4 バイト以上 (AID バイト、カーソル・アドレス、
データおよび SBA コマンド) になります。最後のケースの場合、カーソル・
アドレスに続くものが、最初の EXEC CICS RECEIVE コマンドで、トランザ
クション・プログラムに渡されます。
端末リソースが CICS_EpiAddTerminal を指定してインストールされている場
合は、3270 データ・ストリームの長さは、CICS_EpiDetails_t の MaxData の
値を超えてはなりません。
EPI は、このパラメーターを入力用のみに使用します。
Size
データのサイズ (バイト) です。
EPI は、このパラメーターを入力用のみに使用します。
戻りコード:
第 4 章 C および COBOL
163
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_BAD_INDEX
TermIndex 値は有効な端末索引ではありません。
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_NO_CONVERSE
端末リソースでは、応答は予想されません。
CICS_EPI_ERR_NO_DATA
応答データはありませんでした。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_ERR_SERVER_DOWN
サーバーがダウンしたために、関数が失敗しました。
CICS_EPI_ERR_ABENDED
読み取りタイムアウト期間が期限切れになり、会話が異常終了しましたが、ア
プリケーションはまだ CICS_EPI_EVENT_END_TRAN イベントを受け取って
いません。
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiATIState
CICS_EpiATIState
TermIndex
ATIState
目的: CICS_EpiATIState 関数によって、呼び出し側のアプリケーションは、端末リソ
ースに対する ATI 要求の処理方法を照会し、変更することができます。 ATI 要求が使
用可能 (CICS_EPI_ATI_ON) で、ATI 要求がサーバーで出される場合は、端末リソース
が解放されたときに要求が開始されます。 ATI 要求が保留 (CICS_EPI_ATI_HOLD) の
場合は、出された ATI 要求はいずれもキューに入れられ、ATI 要求は、次回、使用可
能になったときに開始されます。
CICS_EpiAddTerminal 呼び出し後の ATI 要求の状態は CICS_EPI_ATI_HOLD です。
EPI アプリケーションは、 ATI 要求の処理ができるようになれば、その状態を
CICS_EPI_ATI_ON に変更することができます。 (サーバーは、EPI で維持される ATI
状態とは別に、端末リソースの ATI 状態も維持しています。サーバー上の ATI 状態に
変更があっても、EPI 側の ATI 状態には影響しません。)
パラメーター:
164
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
TermIndex
ATI 状態が要求される端末リソースの端末索引。
EPI は、このパラメーターを入力用のみに使用します。
ATIState
EPI は、以下の入力値に応じて、このパラメーターを入出力の両方で使用しま
す。
CICS_EPI_ATI_ON
ATI 要求を使用可能にします。さらに、前の ATI 状態をこのパラメ
ーターで戻します。
CICS_EPI_ATI_HOLD
ATI 要求を次回に使用可能になるまで保留にします。さらに、前の
ATI 状態をこのパラメーターで戻します。
CICS_EPI_ATI_QUERY
ATI 状態は変更しません。現在の状態をこのパラメーターで戻すだけ
です。
戻りコード:
CICS_EPI_ERR_ATI_STATE
与えられた ATIState 値が無効です。
CICS_EPI_ERR_BAD_INDEX
TermIndex 値は有効な端末索引ではありません。
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_NULL_PARAM
ATIState がヌル・ポインターでした。
CICS_EPI_NORMAL
関数が正常に完了しました。
CICS_EpiGetEvent
CICS_EpiGetEvent
TermIndex
Wait
Event
第 4 章 C および COBOL
165
EPI 関数
作成日付: 2005年12月2日
目的: CICS_EpiGetEvent 関数は、端末リソースで発生したイベントに関する情報を
取得します。
この呼び出しは、コールバック・ルーチンからではなく、アプリケーションからのみ、
実行できるということを忘れないでください。
パラメーター:
TermIndex
イベントを取得する対象の端末リソースの端末索引です。これを定数
CICS_EPI_TERM_INDEX_NONE に設定すると、このアプリケーションが使用
する任意の端末リソースに対して、次に戻されるイベントを示すことができま
す。アプリケーションは、戻された CICS_EpiEventData_t 構造の TermIndex
フィールドを調べて、生成されたイベントの対象となる端末リソースを判別す
ることができます。
EPI は、このパラメーターを入出力の両方で使用します。
Wait
端末リソースに対してイベントが生成されない場合、何が起こったかを示して
います。次のいずれかの値を使用します。
CICS_EPI_WAIT
次のイベントが発生するまで戻りません。
CICS_EPI_NOWAIT
エラー・コードを伴って即時に戻ります。このオプションは、アプリ
ケーションがイベントのポーリングを選んだ場合に使用されます。
EPI は、このパラメーターを入力用のみに使用します。
Event
戻り時に発生したイベントの詳細情報を持っている CICS_EpiEventData_t 構
造へのポインター。この構造の Data フィールドは、イベント関連のすべての
端末データ・ストリームで更新されるデータ・バッファーを指すように設定す
る必要があります。 Size フィールドは、このバッファーの最大サイズを示す
ように設定する必要があります。このフィールドは更新されて、戻されるデー
タの実際の長さが入ります。
戻りコード:
CICS_EPI_ERR_BAD_INDEX
TermIndex 値は有効な端末索引ではありません。
CICS_EPI_ERR_FAILED
関数は予期しない理由により失敗しました。
CICS_EPI_ERR_MORE_DATA
与えられたデータ・バッファーは、端末データが入るだけの大きさがありませ
ん。データは切り捨てられました。
166
CICS Transaction Gateway: プログラミング・リファレンス
EPI 関数
作成日付: 2005年12月2日
CICS_EPI_ERR_MORE_EVENTS
イベントの取得に成功しましたが、この端末リソースに対して、さらに未解決
のイベントがあります。
CICS_EPI_ERR_NO_EVENT
この端末リソースに対して、未解決のイベントはありません。
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize は実行されませんでした。
CICS_EPI_ERR_WAIT
Wait パラメーターが無効です。
CICS_EPI_ERR_NULL_PARM
Event がヌル・ポインターです。
CICS_EPI_ERR_IN_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_EPI_NORMAL
関数は正常に完了しました。他にはイベントはありません。
EPI イベント
EPI イベントは、CICS から EPI アプリケーションに渡すデータがある場合に発生しま
す。アプリケーションは、さまざまな方法で EPI イベントを処理することができます。
「CICS Transaction Gateway: プログラミング・ガイド」のイベントおよびコールバッ
クを参照してください。いずれの仕組みを使用しても、CICS_EpiGetEvent を呼び出
すことによって、CICS からのデータが取得されます。
CICS_EPI_EVENT_ADD_TERM
目的: CICS_EPI_EVENT_ADD_TERM イベントは、端末リソースをインストールする
非同期要求が完了したことを示します。端末リソースがインストールされた場合、詳細
情報は Data が指している CICS_EpiDetails_t 構造に入ります。
フィールド完了:
Event
CICS_EPI_EVENT_ADD_TERM イベント・コード。
EndReturnCode
終了の理由。戻りコードの詳細については、CICS_EpiAddExTerminal 関数を
参照してください。
Data
EndReturnCode が CICS_EPI_NORMAL の場合、端末の詳細情報によって更
新される CICS_EpiDetails_t 構造へのポインター。
第 4 章 C および COBOL
167
EPI イベント
作成日付: 2005年12月2日
CICS_EPI_EVENT_SEND
目的: CICS_EPI_EVENT_SEND イベントは、トランザクションが一部の 3270 データ
を端末リソースに送信 (通常は EXEC CICS SEND コマンドの結果として) したことを
示しています。応答は想定されていないため、何も行う必要はありません。
フィールド完了:
Event
CICS_EPI_EVENT_SEND イベント・コード。
Data
更新されて、トランザクションが送信するデータが入るバッファーへのポイン
ター。データ・ストリーム形式の詳細については、「CICS Transaction
Gateway: プログラミング・ガイド」の EPI 用 3270 データ・ストリームを参
照してください。
Size
Data バッファーのデータの長さ。
CICS_EPI_EVENT_CONVERSE
目的: CICS_EPI_EVENT_CONVERSE イベントは、トランザクションが、EXEC CICS
RECEIVE または EXEC CICS CONVERSE のいずれかのコマンドの結果として応答が
必要であることを示しています。
アプリケーションは、CICS_EpiReply 呼び出しを行って、次のように、データを CICS
に戻す必要があります。
v トランザクションが BUFFER オプションを指定せずに EXEC CICS RECEIVE コマ
ンドを出した場合は、バッファーにはトランザクションから送信されたデータが入る
か、あるいは空のままになります。処理すべきデータがある場合は、応答する前にそ
のデータを処理します。送信すべきデータがある場合は、応答を送信します。
v トランザクションが EXEC CICS RECEIVE BUFFER コマンドを出した場合は、デー
タ・バッファーには 3270 バッファー読み取りコマンドが入り、Size フィールドは 1
に設定されます。応答は直ちに送信する必要があります。
フィールド完了:
Event
CICS_EPI_EVENT_CONVERSE イベント・コード。
Data
上記のように、トランザクションが送信するデータが入るように更新されるバ
ッファーへのポインター。
Size
バッファーのデータの長さ。送信されたデータがないことを示す場合はこの長
さをゼロに設定しますが、それでも応答は必要です。
CICS_EPI_EVENT_END_TRAN
目的: CICS_EPI_EVENT_END_TRAN イベントは、端末リソースに対して実行中であ
ったトランザクションが終了したことを示しています。トランザクションが失敗した場
168
CICS Transaction Gateway: プログラミング・リファレンス
EPI イベント
作成日付: 2005年12月2日
合は、EndReason および EndReturnCode はその原因を明示します。トランザクション
が正常に完了した場合は、EndReason フィールドが CICS_EPI_TRAN_NO_ERROR に
設定され、EndReturnCode が CICS_EPI_NORMAL に設定されます。トランザクショ
ンが疑似会話型の場合は、TransId フィールドに次に必要なトランザクション名が入り
ます。アプリケーションは、CICS_EpiStartTran 呼び出しを出すことによって、このト
ランザクションを開始させる必要があります。
CICS_EPI_EVENT_END_TRAN イベントが発生するのは、端末リソースに対して実行し
ているトランザクションが、異常終了した場合、または IMMEDIATE オプションの指
定がない RETURN コマンドの実行後に終了した場合です。
フィールド完了:
Event
CICS_EPI_EVENT_END_TRAN イベント・コード。
EndReason
終了トランザクション・イベントが発生した原因を示します。次の値のいずれ
かになります。
CICS_EPI_TRAN_NO_ERROR
トランザクションの正常終了。
CICS_EPI_TRAN_NOT_STARTED
トランザクションの開始が失敗しました。
CICS_EPI_TRAN_STATE_UNKNOWN
トランザクションの完了が失敗しました。
CICS_EPI_READTIMEOUT_EXPIRED
読み取りタイムアウトの期限切れです。
TransId
前のトランザクションが疑似会話型の場合、次に開始されるトランザクション
の名前。この名前は、長さが 4 文字で、ヌル終了です。次のトランザクション
がない場合は、このフィールドはヌルに設定されます。
EndReturnCode
CICS_EPI_returncode を含むストリング。
CICS_EPI_EVENT_START_ATI
目的: CICS_EPI_EVENT_START_ATI イベントは、ATI トランザクションが端末リソ
ースに対して開始されたことを示します。端末リソースが別のトランザクションを実行
中に ATI 要求を受信した場合は、トランザクションが終了するまで要求は保留になり
ます。その後、端末リソースのためのトランザクションが開始になり、
CICS_EPI_EVENT_START_ATI イベントが生成されて、アプリケーションに通知されま
す。
フィールド完了:
第 4 章 C および COBOL
169
EPI イベント
作成日付: 2005年12月2日
Event
CICS_EPI_EVENT_START_ATI イベント・コード。
TransId
開始されたトランザクションの名前。この名前は、長さが 4 文字で、ヌル終了
です。
CICS_EPI_EVENT_END_TERM
目的: CICS_EPI_EVENT_END_TERM イベントは、端末リソースが存在しないことを
示します。このイベントの後は、その端末リソースで使用された端末索引は無効になり
ます。 EPI が CICS サーバーのシャットダウンを検出した場合は、アプリケーション
がそのサーバーにインストールしてその後削除されていないすべての端末リソースに対
して、CICS_EPI_EVENT_END_TERM イベントが生成されます。
フィールド完了:
Event
CICS_EPI_EVENT_END_TERM イベント・コード。
EndReason
端末リソースの削除理由を示します。次の値のいずれかになります。
CICS_EPI_END_SIGNOFF
端末リソースはサインオフされました。これは、CESF トランザクシ
ョンの実行の結果、または CICS_EpiDelTerminal 関数の呼び出しの
結果の可能性があります。
CICS_EPI_END_SHUTDOWN
CICS サーバーがシャットダウンしました。
CICS_EPI_END_OUTSERVICE
端末リソースがサービス休止に切り替えられました。
CICS_EPI_END_UNKNOWN
予期しないエラーが発生しました。
CICS_EPI_END_FAILED
端末リソースを削除しようとして失敗しました。
外部セキュリティー・インターフェース
ESI の定数およびデータ構造
このセクションでは、ESI を使用する際に必要となる定数とデータ構造について説明し
ます。
170
CICS Transaction Gateway: プログラミング・リファレンス
ESI 定数およびデータ構造
作成日付: 2005年12月2日
ESI 定数
以下の定数は、この章の ESI データ構造と関数の説明で、シンボル名で参照されていま
す。説明を分かりやすくするために、ここではその値も示しています。ただし、必ず、
ご使用のプログラム言語に合う ESI 定数のシンボル名を使ってコーディングする必要が
あります。
フィールド長
v CICS_ESI_PASSWORD_MAX (10)
v CICS_ESI_SYSTEM_MAX (8)
v CICS_ESI_USERID_MAX (10)
ESI データ構造
ESI で使用できるデータ構造は以下のとおりです。
v CICS_EsiDate_t
v CICS_EsiTime_t
v CICS_EsiDetails_t
データ構造のフィールド記述でストリングとして記述されているフィールドは、ヌル終
了ストリングです。
CICS_EsiDate_t:
目的: CICS_EsiDate_t 構造は、年、月、および日で表された日付を含んでいます。
フィールド:
Year
cics_ushort_t 形式で保持される 4 桁の年。
Month
cics_ushort_t の形式で保持される月。値の範囲は、1 から 12 までであり、1
は 1 月を表します。
Day
cics_ushort_t の形式で保持される日。値の範囲は、1 から 31 までであり、1
はその月の最初の日を表します。
CICS_EsiTime_t:
目的: CICS_EsiTime 構造は、時間、分、秒、および 100 分の 1 秒で表された時間
を含んでいます。
フィールド:
Hours
cics_ushort_t の形式で保持される時間。値の範囲は、0 から 23。
Minutes
cics_ushort_t の形式で保持される分。値の範囲は、0 から 59。
Seconds
cics_ushort_t の形式で保持される秒。値の範囲は、0 から 59。
第 4 章 C および COBOL
171
ESI 定数およびデータ構造
Hundredths
作成日付: 2005年12月2日
cics_ushort_t の形式で保持される 100 分の 1 秒。値の範囲は、0 か
ら 99。
CICS_EsiDetails_t:
目的: CICS_EsiDetails_t 構造は、CICS_VerifyPassword 関数もしくは
CICS_ChangePassword 関数の正常な呼び出しから戻された情報を含んでいます。
フィールド:
LastVerifiedDate
パスワードが最後に検査された日付。
LastVerifiedTime
パスワードが最後に検査された時刻。
ExpiryDate
パスワードの有効期限が切れる日付。
ExpiryTime
パスワードの有効期限が切れる時刻。
LastAccessDate
ユーザー ID が最後にアクセスされた日付。
LastAccessTime
ユーザー ID が最後にアクセスされた時刻。
InvalidCount
ユーザー ID に対して入力された無効なパスワードの回数。
ESI 関数
このセクションでは、アプリケーション・プログラムから呼び出すことができる ESI に
よって提供される関数について説明します。
v CICS_VerifyPassword
v CICS_ChangePassword
v CICS_SetDefaultSecurity
CICS_VerifyPassword
CICS_VerifyPassword
172
CICS Transaction Gateway: プログラミング・リファレンス
UserId
Password
System
Details
ESI 関数
作成日付: 2005年12月2日
目的: CICS_VerifyPassword 関数は、パスワードが、指定されたユーザー ID 用に外
部セキュリティー・マネージャーが記録しているパスワードと一致しているかどうか
を、クライアント・アプリケーションが検査できるようにします。
外部セキュリティー・マネージャーは、クライアントの接続されたサーバーにあるもの
と見なされていることに注意してください。
パラメーター:
UserId
パスワードを検査するユーザー ID を指定したヌル終了ストリングへ
のポインター。ユーザー ID が CICS_ESI_USERID_MAX 文字より短
い場合は、CICS_ESI_USERID_MAX+1 の長さまでヌルを埋め込む必
要があります。
ESI は、このパラメーターを入力用のみに使用します。
Password
指定されたユーザー ID について外部セキュリティー・マネージャー
が検査するパスワードを指定したヌル終了ストリングへのポインタ
ー。パスワードが CICS_ESI_PASSWORD_MAX 文字より短い場合
は、CICS_ESI_PASSWORD_MAX+1 の長さまでヌルを埋め込む必要
があります。
ESI は、このパラメーターを入力用のみに使用します。
System
パスワードを検査するサーバーの名前を指定したヌル終了ストリング
へのポインター。ユーザー ID が CICS_ESI_SYSTEM_MAX 文字より
短い場合は、CICS_ESI_SYSTEM_MAX+1 の長さまでヌルを埋め込む
必要があります。
ストリングがすべてヌルの場合は、デフォルト・サーバーが選択され
ます。
ESI は、このパラメーターを入力用のみに使用します。
Details
外部セキュリティー・マネージャーによって戻される詳細情報が戻さ
れる時に含まれている CICS_EsiDetails_t 構造へのポインター。
ESI は、この構造のフィールドを出力用のみに使用します。
戻りコード:
CICS_ESI_NO_ERROR
関数が正常に完了しました。
第 4 章 C および COBOL
173
ESI 関数
作成日付: 2005年12月2日
CICS_ESI_ERR_CALL_FROM_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_ESI_ERR_SYSTEM_ERROR
内部システム・エラーが発生しました。
CICS_ESI_ERR_NO_CICS
CICS Transaction Gateway が使用できないか、または指定されたサーバーが使
用できません。
CICS_ESI_ERR_CICS_DIED
指定されたサーバーは、使用できなくなりました。
CICS_ESI_ERR_RESOURCE_SHORTAGE
CICS Transaction Gateway は、要求を完了するのに十分なリソースがありませ
んでした。
CICS_ESI_ERR_NO_SESSIONS
アプリケーションには、構成でサポートされる数の、未解決の ECI 要求およ
び EPI 要求があります。
CICS_ESI_ERR_UNKNOWN_SERVER
要求されたサーバーは見つかりませんでした。 CICS_EciListSystems および
CICS_EpiListSystems 関数によって戻されたサーバーのみが受け入れ可能で
す。
CICS_ESI_ERR_MAX_SESSIONS
通信リソースが十分ではないため、要求を満たすことができませんでした。使
用できるサーバー数を制御する方法については、ご使用の CICS Transaction
Gateway またはサーバーの資料を参照してください。
CICS_ESI_ERR_MAX_SYSTEMS
構成で許可された数以上のサーバーに対して、要求を開始しようとしました。
使用できるサーバー数を制御する方法については、ご使用の CICS Transaction
Gateway またはサーバーの資料を参照してください。
CICS_ESI_ERR_NULL_USERID
ユーザー ID がヌルに設定されています。
CICS_ESI_ERR_NULL_PASSWORD
パスワードがヌルに設定されています。
CICS_ESI_ERR_PEM_NOT_SUPPORTED
パスワード有効期限管理機能は、要求されたサーバーと SNA および TCP62
を介しての通信でのみサポートされます。
CICS_ESI_ERR_PEM_NOT_ACTIVE
要求されたサーバーは、パスワード有効期限管理機能をサポートしていませ
ん。
174
CICS Transaction Gateway: プログラミング・リファレンス
ESI 関数
作成日付: 2005年12月2日
CICS_ESI_ERR_PASSWORD_EXPIRED
パスワードの有効期限が切れました。
CICS_ESI_ERR_PASSWORD_INVALID
パスワードが無効です。
CICS_ESI_ERR_USERID_INVALID
ユーザー ID が外部セキュリティー・マネージャーに認識されません。
CICS_ESI_ERR_SECURITY_ERROR
外部セキュリティー・マネージャーがエラーを検出しました。ユーザー ID が
取り消されたことが、もっとも考えられる理由です。
実際の戻りコード値をシンボル名にマッピングしたものが、
<install_path>\include\cics_esi.h ファイルに入っています。 COBOL ユーザーの場
合は、<install_path>\copybook\cicsesi.cbl ファイルに入っています。
CICS_ChangePassword
CICS_ChangePassword
UserId
OldPassword
NewPassword
System
Details
目的: CICS_ChangePassword 関数は、指定されたユーザー ID について、外部セキュ
リティー・マネージャーが記録しているパスワードを、クライアント・アプリケーショ
ンが変更できるようにします。
外部セキュリティー・マネージャーは、CICS Transaction Gateway が接続されたサーバ
ーにあるものと見なされていることに注意してください。
パラメーター:
UserId
そのパスワードを変更するユーザー ID を指定したヌル終了ストリン
グへのポインター。ユーザー ID が CICS_ESI_USERID_MAX 文字よ
り短い場合は、CICS_ESI_USERID_MAX+1 の長さまでヌルを埋め込
む必要があります。
ESI は、このパラメーターを入力用のみに使用します。
OldPassword
第 4 章 C および COBOL
175
ESI 関数
作成日付: 2005年12月2日
指定されたユーザー ID の現行パスワードを指定するヌル終了ストリ
ングへのポインター。パスワードが CICS_ESI_PASSWORD_MAX 文
字より短い場合は、CICS_ESI_PASSWORD_MAX+1 の長さまでヌル
を埋め込む必要があります。
ESI は、このパラメーターを入力用のみに使用します。
NewPassword
指定されたユーザー ID の新規パスワードを指定するヌル終了ストリ
ングへのポインター。パスワードが CICS_ESI_PASSWORD_MAX 文
字より短い場合は、CICS_ESI_PASSWORD_MAX+1 の長さまでヌル
を埋め込む必要があります。
パスワードは、現行のパスワードが正しく指定されている場合に限り
変更されます。
ESI は、このパラメーターを入力用のみに使用します。
System
パスワードを検査するサーバーの名前を指定したヌル終了ストリング
へのポインター。ユーザー ID が CICS_ESI_SYSTEM_MAX 文字より
短い場合は、CICS_ESI_SYSTEM_MAX+1 の長さまでヌルを埋め込む
必要があります。
ストリングがすべてヌルの場合は、デフォルト・サーバーが選択され
ます。
ESI は、このパラメーターを入力用のみに使用します。
Details
外部セキュリティー・マネージャーによって戻される詳細情報が戻さ
れる時に含まれている CICS_EsiDetails_t 構造へのポインター。
ESI は、この構造のフィールドを出力用のみに使用します。
戻りコード:
CICS_ESI_NO_ERROR
関数が正常に完了しました。
CICS_ESI_ERR_CALL_FROM_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_ESI_ERR_SYSTEM_ERROR
内部システム・エラーが発生しました。
CICS_ESI_ERR_NO_CICS
CICS Transaction Gateway が使用できないか、または指定されたサーバーが使
用できません。
176
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
ESI 関数
CICS_ESI_ERR_CICS_DIED
指定されたサーバーは、使用できなくなりました。パスワードが変更されたこ
とを確認するには、CICS_VerifyPassword 関数を使用します。
CICS_ESI_ERR_RESOURCE_SHORTAGE
CICS Transaction Gateway は、要求を完了するのに十分なリソースがありませ
んでした。
CICS_ESI_ERR_NO_SESSIONS
アプリケーションには、構成でサポートされる数の、未解決の ECI 要求およ
び EPI 要求があります。
CICS_ESI_ERR_UNKNOWN_SERVER
要求されたサーバーは見つかりませんでした。 CICS_EciListSystems および
CICS_EpiListSystems 関数によって戻されたサーバーのみが受け入れ可能で
す。
CICS_ESI_ERR_MAX_SESSIONS
通信リソースが十分ではないため、要求を満たすことができませんでした。使
用できるサーバー数を制御する方法については、ご使用の CICS Transaction
Gateway またはサーバーの資料を参照してください。
CICS_ESI_ERR_MAX_SYSTEMS
構成で許可された数以上のサーバーに対して、要求を開始しようとしました。
使用できるサーバー数を制御する方法については、ご使用の CICS Transaction
Gateway またはサーバーの資料を参照してください。
CICS_ESI_ERR_NULL_USERID
ユーザー ID がヌルに設定されています。
CICS_ESI_ERR_NULL_OLD_PASSWORD
現行パスワードがヌルに設定されています。
CICS_ESI_ERR_NULL_NEW_PASSWORD
新規パスワードがヌルに設定されています。
CICS_ESI_ERR_PEM_NOT_SUPPORTED
パスワード有効期限管理機能は、要求されたサーバーと SNA および TCP62
を介しての通信でのみサポートされます。
CICS_ESI_ERR_PEM_NOT_ACTIVE
要求されたサーバーは、パスワード有効期限管理機能をサポートしていませ
ん。
CICS_ESI_ERR_PASSWORD_INVALID
パスワードが無効です。
CICS_ESI_ERR_PASSWORD_REJECTED
新規パスワードは、外部セキュリティー・マネージャーで定義された標準に準
拠していません。
第 4 章 C および COBOL
177
ESI 関数
作成日付: 2005年12月2日
CICS_ESI_ERR_USERID_INVALID
ユーザー ID が外部セキュリティー・マネージャーに認識されません。
CICS_ESI_ERR_SECURITY_ERROR
外部セキュリティー・マネージャーによってエラーが検出されました。ユーザ
ー ID が取り消されたことが、もっとも考えられる理由です。
実際の戻りコード値をシンボル名にマッピングしたものが、
<install_path>\include\cics_esi.h ファイルに入っています。 COBOL ユーザーの場
合は、<install_path>\copybook\cicsesi.cbl ファイルに入っています。
CICS_SetDefaultSecurity
CICS_SetDefaultSecurity
UserId
Password
System
目的: CICS_SetDefaultSecurity 関数によって、クライアント・アプリケーションは、
サーバーに渡される ECI および EPI 要求でデフォルトのユーザー ID とパスワードを
使用するように指定することができます。
ユーザー ID およびパスワードはヌル、すなわち、2 進ゼロに設定することができま
す。この場合、デフォルトのユーザー ID とパスワードは設定解除されるため、CICS
Transaction Gateway はユーザー ID とパスワードが設定されていないかのように動作し
ます。
また、ユーザー ID およびパスワードをスペースとして設定することもできます。ただ
し、これは CICS 接続定義で Usedfltuser=yes が指定されている場合のみ有効です。こ
の場合、CICS はそのデフォルトのユーザー ID を使用します。 Usedfltuser 指定の詳細
については、ご使用の CICS サーバーの資料を参照してください。
クライアント・アプリケーションは、ユーザー ID とパスワードを検査する責任があり
ます。
必要であれば、ユーザー ID とパスワードは、いくつかの場所の中の 1 つから取得でき
ることに注意してください。この場合、CICS Transaction Gateway は次の検索順序を使
用しているものとします。
1. ECI の ECI パラメーター・ブロック、または CICS_EpiSetSecurity 関数によって設
定された端末固有値のいずれか。
2. CICS_SetDefaultSecurity 関数によって設定されたサーバー固有の値。
3. CICS Transaction Gateway のポップアップ・ウィンドウからのデフォルト。たとえ
ば、Windows ユーザー ID など。
パラメーター:
178
CICS Transaction Gateway: プログラミング・リファレンス
ESI 関数
作成日付: 2005年12月2日
UserId
設定するユーザー ID を指定したヌル終了ストリングへのポインタ
ー。ユーザー ID が CICS_ESI_USERID_MAX 文字より短い場合は、
CICS_ESI_USERID_MAX+1 の長さまでヌルを埋め込む必要がありま
す。
ESI は、このパラメーターを入力用のみに使用します。
Password
指定されたユーザー ID に対して設定するパスワードを指定したヌル
終了ストリングへのポインター。パスワードが
CICS_ESI_PASSWORD_MAX 文字より短い場合は、
CICS_ESI_PASSWORD_MAX+1 の長さまでヌルを埋め込む必要があ
ります。
ESI は、このパラメーターを入力用のみに使用します。
System
パスワードとユーザー ID が設定されるサーバーの名前を指定したヌ
ル終了ストリングへのポインター。ユーザー ID が
CICS_ESI_SYSTEM_MAX 文字より短い場合は、
CICS_ESI_SYSTEM_MAX+1 の長さまでヌルを埋め込む必要がありま
す。
ストリングがすべてヌルの場合は、デフォルト・サーバーが選択され
ます。
ESI は、このパラメーターを入力用のみに使用します。
戻りコード:
CICS_ESI_NO_ERROR
関数が正常に完了しました。
CICS_ESI_ERR_CALL_FROM_CALLBACK
関数がコールバック・ルーチンから呼び出されました。
CICS_ESI_ERR_SYSTEM_ERROR
内部システム・エラーが発生しました。
CICS_ESI_ERR_NO_CICS
CICS Transaction Gateway が使用できないか、または指定されたサーバーが使
用できません。
CICS_ESI_ERR_UNKNOWN_SERVER
要求されたサーバーは見つかりませんでした。 CICS_EciListSystems および
CICS_EpiListSystems 関数によって戻されたサーバーのみが受け入れ可能で
す。
第 4 章 C および COBOL
179
ESI 関数
作成日付: 2005年12月2日
CICS_ESI_ERR_USERID_INVALID
ユーザー ID の長さが、CICS_ESI_USERID_MAX を超えています。
CICS_ESI_ERR_PASSWORD_INVALID
パスワードの長さが CICS_ESI_PASSWORD_MAX を超えています。
実際の戻りコード値をシンボル名にマッピングしたものが、
<install_path>\include\cics_esi.h ファイルに入っています。 COBOL ユーザーの場
合は、<install_path>\copybook\cicsesi.cbl ファイルに入っています。
180
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
第 5 章 ECI と EPI の出口
この章では、ECI および EPI ユーザー出口の参照情報を載せています。
出口のインストールと使用法については、「CICS Transaction Gateway: プログラミン
グ・ガイド」を参照してください。
出口ルーチンについて、以下の見出しにしたがって説明しています。
v 目的 - 出口が行おうとしている処理の種類を説明します。
v 呼び出し時点 - ECI または EPI 処理のどこで出口を呼び出すかを示します。
v パラメーター - 出口で提供されるパラメーターについて説明します。パラメーターは
以下のように分類されます。
– 入力 - 出口はこれを参照できますが、変更はできません。
– 出力 - 出口はこれを参照してはなりませんが、その中に値を保管する必要があり
ます。
– 入出力 - 出口はこれを参照し、その中に値を保管することができます。
v 戻りコード - 出口が ECI または EPI に戻すことができる値について記述します。
いずれの場合も、ECI または EPI のそれ以降の動作について説明します。
ECI 出口の解説
このセクションでは、以下の出口について説明します。
v CICS_EciInitializeExit
v CICS_EciTerminateExit
v CICS_EciExternalCallExit1
v CICS_EciExternalCallExit2
v CICS_EciSystemIdExit
v CICS_EciDataSendExit
v CICS_EciDataReturnExit
v CICS_EciSetProgramAliasExit
182 ページの表 2 は、出口の名前、それぞれの出口に渡されるパラメーター、および可
能な戻りコードを要約しています。
© Copyright IBM Corp. 1989, 2005
181
ECI 出口
作成日付: 2005年12月2日
表 2. ECI 出口の要約
関数名
パラメーター
戻りコード:
CICS_EciInitializeExit
Version
Anchor
CICS_EXIT_OK
CICS_EXIT_NO_EXIT
CICS_EXIT_CANT_INIT_EXITS
ユーザー定義のもの
CICS_EciTerminateExit
Anchor
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_STORAGE
ユーザー定義のもの
CICS_EciExternalCallExit1
Anchor
Token
ParmPtr
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EciExternalCallExit2
Anchor
Token
ParmPtr
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EciSystemIdExit
Anchor
Token
ParmPtr
Reason
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
CICS_EXIT_GIVE_UP
ユーザー定義のもの
CICS_EciDataSendExit
Anchor
Token
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EciDataReturnExit
Anchor
Token
ParmPtr
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EciSetProgramAliasExit
Anchor
EciParms
Program
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
識別トークン
同じ ECI 要求に対する複数の呼び出しを出口が関連付けできるようにするために、
CICS_EciInitializeExit と CICS_EciTerminateExit を除くすべての出口で、識別トーク
182
CICS Transaction Gateway: プログラミング・リファレンス
ECI 出口
作成日付: 2005年12月2日
ンがパラメーターとして渡されます。同じ呼び出しに関連する
CICS_EciExternalCallExit1 および CICS_EciExternalCallExit2、さらに
CICS_EciDataSendExit、CICS_EciDataReturnExit 、および CICS_EciSystemIdExit 出
口に介入する場合、トークンは同じです。 (応答請求要求に対しては、
CICS_EciExternalCallExit1 および CICS_EciExternalCallExit2 は呼び出されないこと
に注意してください。)
要求が継続している間は、要求を開始したオペレーティング・システム内でトークンは
固有です。要求の最後の出口の呼び出しが完了すると、そのトークンは再利用すること
ができます。
拡張された作業論理単位の場合は、作業論理単位内の要求が異なれば、トークンも異な
ることがあります。 (ただし、トークンは再利用できるという理由と、直前の非同期要
求での ECI_GET_REPLY 要求が完了するまで新しいプログラム・リンク呼び出しは実
行できないという理由で、トークンは同じになる可能性もあります。)
トークンの長さは 8 バイトです。8 バイトのヌルは、トークンとしては無効な値のた
め、出口には渡されません。
プロセス・モデルのインプリメンテーション
特定の要求に関連した出口 (すなわち、同じ識別トークンを持つ) はすべて、アプリケ
ーション・プロセスのコンテキストで呼び出されます。
CICS_EciInitializeExit
関数名:
CICS_EciInitializeExit
パラメーター
Version
Anchor
目的: ユーザーが出口環境をセットアップできるようにします。
呼び出し時点: パラメーターの検証が行われた後、それぞれのプロセスごとに、
CICS_ExternalCall を最初に呼び出したとき。
パラメーター:
Version
入力パラメーター。出口を実行する ECI のバージョン。
Anchor
出力パラメーター。ECI 出口に渡されるポインターへのポインター。
2 番目のポインターは ECI では使用されず、そのまま出口に渡され
ます。この出口の中にストレージを確保して、そのアドレスを他の出
口に渡すことができます。
戻りコード:
第 5 章 ECI と EPI の出口
183
ECI 出口
作成日付: 2005年12月2日
CICS_EXIT_OK
ECI は、必要に応じて出口を呼び出しながら、この要求の処理を続けます。
CICS_EXIT_NO_EXIT
ECI は、この要求の処理を続けますが、これ以上、出口を呼び出すことはあり
ません。
CICS_EXIT_CANT_INIT_EXITS
ECI は、CICS Transaction Gateway トレース・レコードを書き込んでから、こ
の要求の処理を続けますが、これ以上、出口を呼び出すことはありません。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 ECI は、CICS Transaction Gateway トレース・レコードを書き
込んでから、この要求の処理を続けますが、これ以上、出口を呼び出すことは
ありません。
CICS_EciTerminateExit
関数名:
CICS_EciTerminateExit
パラメーター
Anchor
目的: ユーザーが出口環境をクリーンアップできるようにします。
CICS_EciInitializeExit が獲得したストレージは、いずれもこの出口で解放する必要があ
ります。
CICS_EciTerminateExit は、クライアント・デーモンが呼び出すことはありません。
呼び出し時点: CICS_EciInitializeExit を出したプロセスの終了時。
パラメーター:
Anchor 入力パラメーター。CICS_EciInitializeExit によってセットアップされたポイン
ター。
戻りコード:
CICS_EXIT_OK
終了処理が続きます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。ECI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、終了処理を続けま
す。
184
CICS Transaction Gateway: プログラミング・リファレンス
ECI 出口
作成日付: 2005年12月2日
CICS_EXIT_BAD_STORAGE
CICS がストレージ・エラーを検出しました。ECI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、終了処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 ECI は、CICS Transaction Gateway トレース・レコードを書き
込んでから、終了処理を続けます。
CICS_EciExternalCallExit1
関数名:
CICS_EciExternalCallExit1
パラメーター:
Anchor
Token
ParmPtr
目的: ユーザーがプログラムを実行するのに最適なシステムを選出できるようにしま
す。この出口は、それぞれのプログラム・リンクごとに、およびそれぞれの状況情報の
呼び出しごとに、正確に 1 回ずつ呼び出されます。応答請求呼び出しでは呼び出されま
せん。 eci_luw_token がゼロでない場合はこの出口が呼び出されますが、作業論理単位
が開始した時点でサーバーが選択されるため、eci_system_name に加えた変更は無視さ
れます。
呼び出し時点: ECI によるパラメーターの検証後、それぞれのプログラム・リンク呼
び出しごとに、およびそれぞれの状況情報呼び出しごとに、CICS_ExternalCall を呼び
出した時点。
パラメーター:
Anchor
入力パラメーター。CICS_EciInitializeExit によってセットアップされ
たポインター。
Token
入力パラメーター。この要求用に ECI によって設定された識別トー
クン。
ParmPtr
入力パラメーター。ECI パラメーター・ブロックへのポインター。出
口は、ECI パラメーター・ブロック内のすべてのフィールドを入力と
して扱う必要があります。ただし、変更が可能な eci_system_name フ
ィールドは除きます。
戻りコード:
CICS_EXIT_OK
ECI パラメーター・ブロックで現在、指定されている eci_system_name を用い
て、ECI は処理を継続します。
第 5 章 ECI と EPI の出口
185
ECI 出口
作成日付: 2005年12月2日
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。 ECI は CICS
Transaction Gateway トレース・レコードを書き込んでから、現在、ECI パラメ
ーター・ブロックで指定されている eci_system_name を用いて、ECI は要求の
処理を継続します。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。 ECI は CICS Transaction
Gateway トレース・レコードを書き込んでから、現在、ECI パラメーター・ブ
ロックで指定されている eci_system_name を用いて、ECI は要求の処理を継続
します。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 ECI は CICS Transaction Gateway トレース・レコードを書き込
んでから、現在、ECI パラメーター・ブロックで指定されている
eci_system_name を用いて、ECI は要求の処理を継続します。
注: 出口が新しいシステムを選択できるための条件には、一連の制約があります。出口
がシステムを選択できるのは、呼び出しがプログラム・リンクまたは状況情報の呼び出
しであり、かつ新規の作業論理単位が開始される場合です。その他の場合は、出口は
CICS_EXIT_OK を戻すことになります。
呼び出し側アプリケーションが、システム名として 2 進ゼロをパラメーター・ブロック
に書き込んだ場合は、このアプリケーションはシステムが動的に選択されると見なして
おり、出口は問題なくシステムを選択することができます。
しかしながら、呼び出し側アプリケーションがシステム名をパラメーター・ブロックに
入れた場合、あるいはアプリケーションがバージョン 0 のアプリケーションの場合は、
アプリケーションはターゲット・システムが変更されるとは見なしていないことがある
ため、アプリケーション・エラーが生じる恐れがあります。この場合は、通常、出口は
代わりのシステムを指定しないため、指定したシステム名またはデフォルトのシステム
名が使用されることになります。この状況下で、出口が選択したシステムを変更するこ
とにした場合、変更は可能ですが、以下の点について留意する必要があります。
v ターゲット・システムの変更によって、クライアント上で実行している ECI アプリ
ケーションでエラーを生じるかどうかを出口ルーチンは重視する必要があります。
v 出口ルーチンは、知識ベースを維持し、そこで得られる適切なデータに基き、クライ
アント・アプリケーションにとってその変更が受け入れ可能かどうかを判断する必要
があります。
186
CICS Transaction Gateway: プログラミング・リファレンス
ECI 出口
作成日付: 2005年12月2日
CICS_EciExternalCallExit2
関数名:
CICS_EciExternalCallExit2
パラメーター:
Anchor
Token
ParmPtr
目的: 情報収集のみの目的で、ユーザーが同期 ECI 呼び出しの結果を確認できるよう
にします。この出口は、それぞれのアプリケーション・プログラム・リンクごと、また
はそれぞれの状況情報呼び出しごとに、正確に 1 回ずつ呼び出されます。応答請求呼び
出しでは呼び出されません。
呼び出し時点: ECI 呼び出しがアプリケーションに戻る前、かつ、戻りデータを ECI
パラメーター・ブロックに入れた後。
パラメーター:
Anchor
入力パラメーター。CICS_EciInitializeExit によってセットアップされ
たポインター。
Token
入力パラメーター。この要求用に ECI によって設定された識別トー
クン。
ParmPtr
入力パラメーター。ECI パラメーター・ブロックへのポインター。出
口は、ECI パラメーター・ブロック内のすべてのフィールドを入力と
して扱う必要があります。
戻りコード:
CICS_EXIT_OK
ECI は、CICS_ExternalCall 要求を出したアプリケーションに制御を戻しま
す。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。ECI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、
CICS_ExternalCall 要求を出したアプリケーションに制御を戻します。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。ECI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_ExternalCall 要求を出
したアプリケーションに制御を戻します。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
第 5 章 ECI と EPI の出口
187
ECI 出口
作成日付: 2005年12月2日
があります。 ECI は、CICS Transaction Gateway トレース・レコードを書き
込んでから、CICS_ExternalCall 要求を出したアプリケーションに制御を戻し
ます。
CICS_EciSystemIdExit
関数名:
CICS_EciSystemIdExit
パラメーター:
Anchor
Token
ParmPtr
Reason
目的: ECI パラメーター・ブロックに与えられた名前が無効な場合、ユーザーが新し
いシステム名を指定できるようにします。
呼び出し時点: 新しいシステム、ユーザー ID、またはパスワードを選択することに
よって、訂正できるようなエラーが生じた場合に、この出口が呼び出されます。 ECI
が以下のいずれかのコードを戻した場合がそれに該当します。
v ECI_ERR_NO_CICS
v ECI_ERR_UNKNOWN_SERVER
v ECI_ERR_SECURITY_ERROR
v ECI_ERR_SYSTEM_ERROR
v ECI_ERR_RESOURCE_SHORTAGE
v ECI_ERR_MAX_SYSTEMS.
サーバーへのデータの送信前にクライアント・デーモンがエラーを検出したとき、また
はデータがサーバーから戻された後、これを呼び出すことができます。
パラメーター:
188
Anchor
入力パラメーター。CICS_EciInitializeExit によってセットアップされ
たポインター。
Token
入力パラメーター。この要求用に ECI によって設定された識別トー
クン。
ParmPtr
入力パラメーター。ECI パラメーター・ブロックへのポインター。出
口は、ECI パラメーター・ブロック内のすべてのフィールドを入力と
して扱う必要があります。
v eci_system_name
v eci_userid
v eci_password.
CICS Transaction Gateway: プログラミング・リファレンス
ECI 出口
作成日付: 2005年12月2日
Reason
入力パラメーター。アプリケーション要求がこれまで成功しなかった
理由を説明する標準 ECI エラー・コード。
戻りコード:
CICS_EXIT_OK
ECI パラメーター・ブロックの新規パラメーターを使用して、ECI はアプリケ
ーション呼び出しを再試行します。 (アプリケーションから
CICS_ExternalCall に渡された CICS プログラム通信域は保存されます。) ア
プリケーション・コールバック・ルーチンも、CICS_EciExternalCallExit2 も呼
び出されません。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。ECI は CICS
Transaction Gateway トレース・レコードを書き込んでから、
CICS_ExternalCall 要求を出したアプリケーションに戻ります。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。ECI は CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_ExternalCall 要求を出
したアプリケーションに戻ります。
CICS_EXIT_GIVE_UP
ECI は CICS_ExternalCall 要求を出したアプリケーションに戻ります。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 ECI は CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EXIT_OK の説明のように、アプリケーション呼び出しを再試
行します。
CICS_EciDataSendExit
関数名:
CICS_EciDataSendExit
パラメーター:
Anchor
Token
目的: パフォーマンス分析のために、ユーザーが呼び出し時刻を設定できるようにし
ます。
呼び出し時点: 要求がサーバーに送信される時刻にできるだけ近い時点。
パラメーター:
Anchor
入力パラメーター。CICS_EciInitializeExit によってセットアップされ
たポインター。
第 5 章 ECI と EPI の出口
189
ECI 出口
作成日付: 2005年12月2日
Token
入力パラメーター。この要求用に ECI によって設定された識別トー
クン。
戻りコード:
CICS_EXIT_OK
ECI は要求の処理を続けます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。ECI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、要求の処理を続け
ます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。ECI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、要求の処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 ECI は、CICS Transaction Gateway トレース・レコードを書き
込んでから、要求の処理を続けます。
CICS_EciDataReturnExit
関数名:
CICS_EciDataReturnExit
パラメーター:
Anchor
Token
ParmPtr
目的: パフォーマンス分析のために、ユーザーが呼び出し時刻を設定できるようにし
ます。
呼び出し時点: サーバーから応答を受信した時刻、およびアプリケーションへ最終的
に戻される ECI ブロックと COMMAREA データが構築された時刻にできるだけ近い時
点。また、これはサーバーからの応答がないためにタイムアウトが生じた場合も呼び出
されます。
パラメーター:
190
Anchor
入力パラメーター。CICS_EciInitializeExit によってセットアップされ
たポインター。
Token
入力パラメーター。この要求用に ECI によって設定された識別トー
クン。
CICS Transaction Gateway: プログラミング・リファレンス
ECI 出口
作成日付: 2005年12月2日
ParmPtr
入力パラメーター。ECI パラメーター・ブロックへのポインター。出
口は、ECI パラメーター・ブロック内のすべてのフィールドを入力と
して扱う必要があります。
戻りコード:
CICS_EXIT_OK
ECI は要求の処理を続けます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。ECI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、要求の処理を続け
ます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。ECI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、要求の処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 ECI は、CICS Transaction Gateway トレース・レコードを書き
込んでから、要求の処理を続けます。
CICS_EciSetProgramAliasExit
関数名:
CICS_EciSetProgramAliasExit
パラメーター:
Anchor
EciParms
Program
目的: CICS Transaction Gateway の Windows 版のワークロード・マネージャーがロー
ド・バランシング用に使用するプログラム名をユーザーが変更できるようにします。
この出口は、ワークロード・マネージャーが使用可能な場合にのみ、使用することがで
きます。
呼び出し時点: ワークロード・マネージャーが、接続先の ECI プログラム用のサー
バーを選択しようとする直前。
パラメーター:
Anchor
入力パラメーター。CICS_EciInitializeExit によってセットアップされ
たポインター。
ECIParms
ECI パラメーター・ブロック
Program
ワークロード・マネージャーがロード・バランシングで使用する ECI
プログラムの別名。
第 5 章 ECI と EPI の出口
191
ECI 出口
作成日付: 2005年12月2日
戻りコード:
CICS_EXIT_OK
ECI は要求の処理を続けます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。ECI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、要求の処理を続け
ます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。ECI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、要求の処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 ECI は、CICS Transaction Gateway トレース・レコードを書き
込んでから、要求の処理を続けます。
EPI 出口の解説
このセクションでは、以下の出口について説明します。
v CICS_EpiInitializeExit
v CICS_EpiTerminateExit
v CICS_EpiAddTerminalExit
v CICS_EpiTermIdExit
v CICS_EpiTermIdInfoExit
v CICS_EpiStartTranExtendedExit
v CICS_EpiStartTranExit
v CICS_EpiReplyExit
v CICS_EpiDelTerminalExit
v CICS_EpiGetEventExit
v CICS_EpiSystemIdExit
v CICS_EpiTranFailedExit
表 3 は、出口の名前、それぞれの出口に渡されるパラメーター、および可能な戻りコー
ドを要約しています。
表 3. EPI 出口の要約
関数名
パラメーター
戻りコード:
CICS_EpiInitializeExit
Version
Anchor
CICS_EXIT_OK
CICS_EXIT_NO_EXIT
CICS_EXIT_CANT_INIT_EXITS
ユーザー定義のもの
192
CICS Transaction Gateway: プログラミング・リファレンス
EPI 出口
作成日付: 2005年12月2日
表 3. EPI 出口の要約 (続き)
関数名
パラメーター
戻りコード:
CICS_EpiTerminateExit
Anchor
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_STORAGE
ユーザー定義のもの
CICS_EpiAddTerminalExit
Anchor
NameSpace
System
NetName
DevType
CICS_EXIT_OK
CICS_EXIT_DONT_ADD_TERMINAL
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiTermIdExit
Anchor
TermIndex
System
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiTermIdInfoExit
Anchor
Version
TermIndex
EpiDetails
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiStartTranExtendedExit
Anchor
TermIndex
TransId
Data
Size
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiStartTranExit
Anchor
TransId
Data
Size
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiReplyExit
Anchor
TermIndex
Data
Size
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiDelTerminalExit
Anchor
TermIndex
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiGetEventExit
Anchor
TermIndex
Wait
Event
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
第 5 章 ECI と EPI の出口
193
EPI 出口
作成日付: 2005年12月2日
表 3. EPI 出口の要約 (続き)
関数名
パラメーター
戻りコード:
CICS_EpiSystemIdExit
Anchor
NameSpace
System
NetName
DevType
FailedSystem
Reason
SubReason
UserId
PassWord
CICS_EXIT_OK
CICS_EXIT_DONT_ADD_TERMINAL
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiTranFailedExit
Anchor
TermIndex
Wait
Event
CICS_EXIT_OK
CICS_EXIT_BAD_ANCHOR
CICS_EXIT_BAD_PARM
ユーザー定義のもの
CICS_EpiInitializeExit
関数名:
CICS_EpiInitializeExit
パラメーター:
Version
Anchor
目的
ユーザーが出口環境をセットアップできるようにします。
呼び出し時点
EPI がパラメーターを検証した後、CICS_EpiInitialize の呼び出し時毎回。
パラメーター
Version
入力パラメーター。出口を実行する EPI のバージョン。
Anchor
出力パラメーター。EPI 出口に渡されるポインターへのポインター。
2 番目のポインターは EPI では使用されず、そのまま出口に渡されま
す。この出口の中にストレージを確保して、そのアドレスを他の出口
に渡すことができます。
戻りコード
CICS_EXIT_OK
EPI は、必要に応じて出口を呼び出しながら、この要求の処理を続けます。
194
CICS Transaction Gateway: プログラミング・リファレンス
EPI 出口
作成日付: 2005年12月2日
CICS_EXIT_NO_EXIT
EPI は、この要求の処理を続けますが、これ以上、出口を呼び出すことはあり
ません。
CICS_EXIT_CANT_INIT_EXITS
EPI は、CICS Transaction Gateway トレース・レコードを書き込んでから、こ
の要求の処理を続けますが、これ以上、出口を呼び出すことはありません。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、この要求の処理を続けますが、これ以上、出口を呼び出すことはあ
りません。
CICS_EpiTerminateExit
関数名:
CICS_EpiTerminateExit
パラメーター:
Anchor
目的
ユーザーが出口環境をクリーンアップできるようにします。 CICS_EpiInitializeExit が
獲得したストレージは、いずれもこの出口で解放する必要があります。
呼び出し時点
EPI がパラメーターを検証した後、CICS_EpiTerminate の呼び出し時毎回。
パラメーター
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
戻りコード
CICS_EXIT_OK
終了処理が続きます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、終了処理を続けま
す。
CICS_EXIT_BAD_STORAGE
CICS がストレージ・エラーを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、終了処理を続けます。
第 5 章 ECI と EPI の出口
195
EPI 出口
作成日付: 2005年12月2日
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、終了処理を続けます。
CICS_EpiAddTerminalExit
関数名:
CICS_EpiAddTerminalExit
パラメーター:
Anchor
NameSpace
System
NetName
DevType
目的
ユーザーがサーバーを選択できるようにするか、あるいは System パラメーターの
CICS_EpiAddTerminal または CICS_EpiAddExTerminal で渡されたサーバーをオーバ
ーライドできるようにします。
呼び出し時点
EPI がパラメーターを検証した後、CICS_EpiAddTerminal または
CICS_EpiAddExTerminal 呼び出し時毎回。
パラメーター
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
NameSpace
入出力パラメーター。入力時における値は、この出口に関係のある
CICS_EpiAddTerminal または CICS_EpiAddExTerminal 呼び出しの
NameSpace パラメーターで指定した値によって異なります。
v ヌル・ポインターを指定した場合は、この入力はヌル・ストリング
へのポインターになります。
v ヌル以外のポインターを指定した場合は、Namespace 入力パラメー
ターがこのデータのコピーを指しています。
出力時における値は、呼び出しで指定された値と同じ方法で、EPI が
使用します。
196
System
入出力パラメーター。入力時における値は、この出口に関係のある
CICS_EpiAddTerminal または CICS_EpiAddExTerminal 呼び出しの
System パラメーターで指定した値です。出力時における値は、呼び出
しで指定された値と同じ方法で、EPI が使用します。
NetName
入出力パラメーター。入力時における値は、この出口に関係のある
CICS Transaction Gateway: プログラミング・リファレンス
EPI 出口
作成日付: 2005年12月2日
CICS_EpiAddTerminal または CICS_EpiAddExTerminal 呼び出しの
NetName パラメーターで指定した値です。出力時における値は、呼び
出しで指定された値と同じ方法で、EPI が使用します。
DevType
入出力パラメーター。入力時における値は、この出口に関係のある
CICS_EpiAddTerminal または CICS_EpiAddExTerminal 呼び出しの
DevType パラメーターで指定した値です。出力時における値は、呼び
出しで指定された値と同じ方法で、EPI が使用します。
戻りコード
CICS_EXIT_OK
NameSpace、System 、NetName、および DevType の出力値を用いて処理が続
けられます。
CICS_EXIT_DONT_ADD_TERMINAL
CICS_EpiAddTerminal または CICS_EpiAddExTerminal が戻りコード
CICS_EPI_ERR_FAILED で終了します。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、CICS_EXIT_OK
の場合と同様に続けます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EXIT_OK の場合と同様
に続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EXIT_OK の場合と同様に続けます。
注
システム選択上の注意:
呼び出し側アプリケーションが、パラメーター・リストにシステム名を指定しない場合
は、このアプリケーションはシステムが動的に選択されると見なしており、出口は問題
なくシステムを選択することができます。
しかしながら、呼び出し側アプリケーションがシステム名を指定した場合は、アプリケ
ーションはターゲット・システムが変更されるとは見なしていないことがあるため、ア
プリケーション・エラーが生じる恐れがあります。この場合、通常、出口は代わりのシ
ステムを指定しないため、指定したシステム名またはデフォルトのシステム名や装置タ
イプなどが使用されることになります。この状況下で、出口が選択したシステムを変更
することにした場合、変更は可能ですが、以下の点について留意する必要があります。
第 5 章 ECI と EPI の出口
197
EPI 出口
作成日付: 2005年12月2日
v ターゲット・システムの変更によって、クライアント上で実行している EPI アプリ
ケーションでエラーを生じるかどうかを出口ルーチンは重視する必要があります。
v 出口ルーチンは、知識ベースを維持し、そこで得られる適切なデータに基き、クライ
アント・アプリケーションにとってその変更が受け入れ可能かどうかを判断する必要
があります。
CICS_EpiAddTerminalExit および CICS_EpiSystemIdExit:
この 2 つの出口の関係は次のとおりです。これらの出口には、システムを選択する機会
が複数回あります。最初の機会は、常に、CICS_EpiAddTerminalExit で起こります。
この出口は、アプリケーションから CICS_EpiAddTerminal または
CICS_EpiAddExTerminal に渡されたパラメーターを受け取るだけです。 CICS が端末
を追加しようとしたときにエラーが生じた場合は (その出口が選択を行ったかどうかに
関係なく)、CICS_EpiSystemIdExit が呼び出されます。さらに、CICS_EpiSystemIdExit
には、端末を追加しようとしたときに生じたエラーが渡され、エラーを訂正する機会も
与えられます。このことは、端末が正常に追加されるまで、あるいは
CICS_EpiSystemIdExit がエラー訂正を放棄するまで、続けられます。
端末を追加しようとしたときにエラーが生じなかった場合は、 CICS_EpiSystemIdExit
が呼び出されることはありません。
CICS_EpiTermIdExit
関数名:
CICS_EpiTermIdExit
パラメーター:
Anchor
TermIndex
System
目的
CICS_EpiAddTerminal 呼び出しが成功した後に割り振られた端末索引を、ユーザーが
確認できるようにします。
CICS_EpiTermIdExit は、古いアプリケーションとの互換性を維持する目的でのみ提供
されています。 EPI 出口を使用する新しいアプリケーションでは、これに代えて、すべ
て CICS_EpiTermIdInfoExit を使用してください。
呼び出し時点
サーバーが端末を割り振った後、CICS_EpiAddTerminal 呼び出し時毎回。
パラメーター
Anchor
198
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
CICS Transaction Gateway: プログラミング・リファレンス
EPI 出口
作成日付: 2005年12月2日
TermIndex
入力パラメーター。予約またはインストールされたばかりの端末リソ
ースの端末索引です。
System
入力パラメーター。端末リソースの予約またはインストールを行うサ
ーバーの名前を指定したヌル終了ストリングへのポインターです。
戻りコード
CICS_EXIT_OK
処理を続行します。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、CICS_EXIT_OK
の場合と同様に続けます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EXIT_OK の場合と同様
に続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EXIT_OK の場合と同様に続けます。
CICS_EpiTermIdInfoExit
関数名:
CICS_EpiTermIdInfoExit
パラメーター:
Anchor
Version
TermIndex
EpiDetails
目的
ユーザーが現在の端末に関する情報を検索できるようにします。
呼び出し時点
CICS 端末がインストールされた直後。
パラメーター
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
Version
入力パラメーター。EPI のバージョン。
第 5 章 ECI と EPI の出口
199
EPI 出口
作成日付: 2005年12月2日
TermIndex
入力パラメーター。インストールされる端末の索引。
EpiDetails
入力パラメーター。インストールされる端末の詳細情報が入っている
CICS_EpiDetails_t 構造へのポインター。
戻りコード
CICS_EXIT_OK
処理を続行します。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、CICS_EXIT_OK
の場合と同様に続けます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EXIT_OK の場合と同様
に続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EXIT_OK の場合と同様に続けます。
CICS_EpiStartTranExtendedExit
関数名:
CICS_EpiStartTranExtendedExit
パラメーター:
Anchor
TermIndex
TransId
Data
Size
目的
ユーザーが、情報収集の目的で、トランザクションの開始を確認できるようにします。
この出口は、システムを選択せず、データも戻しません。
呼び出し時点
EPI がパラメーターを検証した後、CICS_EpiStartTran の呼び出しのとき。
パラメーター
Anchor
200
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
CICS Transaction Gateway: プログラミング・リファレンス
EPI 出口
作成日付: 2005年12月2日
TermIndex
入力パラメーター。この出口に関係のある CICS_EpiReply 呼び出しの
TermIndex パラメーターで指定された値。
TransId
入力パラメーター。この出口に関係のある CICS_EpiStartTran 呼び
出しの TransId パラメーターで指定された値。
Data
入力パラメーター。この出口に関係のある CICS_EpiStartTran 呼び
出しの Data パラメーターで指定された値。
Size
入力パラメーター。この出口に関係のある CICS_EpiStartTran 呼び
出しの Size パラメーターで指定された値。
戻りコード
CICS_EXIT_OK
CICS_EpiStartTran 呼び出しの処理は続きます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、
CICS_EpiStartTran 呼び出しの処理を続けます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EpiStartTran 呼び出し
の処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EpiStartTran 呼び出しの処理を続けます。
CICS_EpiStartTranExit
関数名:
CICS_EpiStartTranExit
パラメーター:
Anchor
TransId
Data
Size
目的
ユーザーが、情報収集の目的で、トランザクションの開始を確認できるようにします。
この出口は、システムを選択せず、データも戻しません。
呼び出し時点
EPI がパラメーターを検証した後、CICS_EpiStartTran の呼び出しのとき。
第 5 章 ECI と EPI の出口
201
EPI 出口
作成日付: 2005年12月2日
パラメーター
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
TransId
入力パラメーター。この出口に関係のある CICS_EpiStartTran 呼び
出しの TransId パラメーターで指定された値。
Data
入力パラメーター。この出口に関係のある CICS_EpiStartTran 呼び
出しの Data パラメーターで指定された値。
Size
入力パラメーター。この出口に関係のある CICS_EpiStartTran 呼び
出しの Size パラメーターで指定された値。
戻りコード
CICS_EXIT_OK
CICS_EpiStartTran 呼び出しの処理は続きます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、
CICS_EpiStartTran 呼び出しの処理を続けます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EpiStartTran 呼び出し
の処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EpiStartTran 呼び出しの処理を続けます。
CICS_EpiReplyExit
関数名:
CICS_EpiReplyExit
パラメーター:
Anchor
TermIndex
Data
Size
目的
ユーザーが、情報収集の目的で、トランザクションの応答を確認できるようにします。
呼び出し時点
EPI がパラメーターを検証した後、CICS_EpiReply の呼び出しのとき。
202
CICS Transaction Gateway: プログラミング・リファレンス
EPI 出口
作成日付: 2005年12月2日
パラメーター
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
TermIndex
入力パラメーター。この出口に関係のある CICS_EpiReply 呼び出し
の TermIndex パラメーターで指定された値。
Data
入力パラメーター。この出口に関係のある CICS_EpiReply 呼び出し
の Data パラメーターで指定された値。
Size
入力パラメーター。この出口に関係のある CICS_EpiReply 呼び出し
の Size パラメーターで指定された値。
戻りコード
CICS_EXIT_OK
CICS_EpiReply 呼び出しの処理は続きます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、CICS_EpiReply
呼び出しの処理を続けます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EpiReply 呼び出しの処
理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EpiReply 呼び出しの処理を続けます。
CICS_EpiDelTerminalExit
関数名:
CICS_EpiDelTerminalExit
パラメーター:
Anchor
TermIndex
目的
ユーザーが端末関連のデータ構造をすべてクリーンアップできるようにします。
呼び出し時点
EPI がパラメーターを検証した後、CICS_EpiDelTerminal または
CICS_EpiPurgeTerminal 呼び出しのとき。ユーザーが端末関連のデータ構造をすべてク
リーンアップできるようにします。
第 5 章 ECI と EPI の出口
203
EPI 出口
作成日付: 2005年12月2日
パラメーター
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
TermIndex
入力パラメーター。この出口に関係のある CICS_EpiDelTerminal ま
たは CICS_EpiPurgeTerminal 呼び出しの TermIndex パラメーター
で指定された値。
戻りコード
CICS_EXIT_OK
CICS_EpiDelTerminal または CICS_EpiPurgeTerminal 呼び出しの処理は続き
ます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、
CICS_EpiDelTerminal または CICS_EpiPurgeTerminal 呼び出しの処理を続け
ます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EpiDelTerminal または
CICS_EpiPurgeTerminal 呼び出しの処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EpiDelTerminal または CICS_EpiPurgeTerminal 呼び出しの
処理を続けます。
CICS_EpiGetEventExit
関数名:
CICS_EpiGetEventExit
パラメーター:
Anchor
TermIndex
Wait
Event
目的
ユーザーが、着信したイベントに関連するデータを収集できるようにします。
呼び出し時点
CICS_EpiGetEvent が呼び出し側に戻る直前。これによって出口は、戻されたデータを
調べたり、システムからの応答の時間設定などを行うことができます。
204
CICS Transaction Gateway: プログラミング・リファレンス
EPI 出口
作成日付: 2005年12月2日
パラメーター
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
TermIndex
入力パラメーター。この出口に関係のある CICS_EpiGetEvent 呼び出
しの TermIndex パラメーターでアプリケーションに戻される値。
Wait
入力パラメーター。この出口に関係のある CICS_EpiGetEvent 呼び出
しの Wait パラメーターに指定された値。
Event
入力パラメーター。この出口に関係のある CICS_EpiGetEvent 呼び出
しの Event パラメーターでアプリケーションに戻される値。
戻りコード
CICS_EXIT_OK
CICS_EpiGetEvent 呼び出しの処理は続きます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、
CICS_EpiGetEvent 呼び出しの処理を続けます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EpiGetEvent 呼び出し
の処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EpiGetEvent 呼び出しの処理を続けます。
CICS_EpiSystemIdExit
関数名:
CICS_EpiSystemIdExit
パラメーター:
Anchor
NameSpace
System
NetName
DevType
FailedSystem
Reason
SubReason
UserId
PassWord
第 5 章 ECI と EPI の出口
205
EPI 出口
作成日付: 2005年12月2日
目的
CICS_Epi_AddTerminal または CICS_EpiAddExTerminal で指定された値が無効な場
合に、ユーザーが新しいシステム名を指定できるようにします。
呼び出し時点
端末を追加しようとしている間にエラーが生じたときに、CICS_EpiAddTerminal また
は CICS_EpiAddExTerminal がアプリケーションに戻る直前。エラーは、
CICS_EPI_ERR_SYSTEM、CICS_EPI_ERR_FAILED、または
CICS_EPI_ERR_SERVER_DOWN の可能性があります。 CICS_EpiAddTerminalExit ま
たは CICS_EpiAddExTerminal が前に呼び出されたかどうかに関係なく、このエラーは
起こります。
注: システムによっては、CICS_EpiAddTerminal または CICS_EpiAddExTerminal の
完了はアプリケーションに非同期的に戻されます。その場合、この出口は非同期的
に呼び出されることになります。
パラメーター
206
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
NameSpace
入出力パラメーター。失敗した CICS_EpiAddTerminal または
CICS_EpiAddExTerminal で使用されていた NameSpace パラメータ
ー。
System
入出力パラメーター。失敗した CICS_EpiAddTerminal または
CICS_EpiAddExTerminal で使用されていた System パラメーター。
NetName
入出力パラメーター。失敗した CICS_EpiAddTerminal または
CICS_EpiAddExTerminal で使用されていた NetName パラメータ
ー。
DevType
入出力パラメーター。失敗した CICS_EpiAddTerminal または
CICS_EpiAddExTerminal で使用されていた DevType パラメータ
ー。
FailedSystem
入力パラメーター。障害が生じたシステムの ID。
Reason
入力パラメーター。障害の理由。 CICS_EPI_ERR_SYSTEM または
CICS_EPI_ERR_FAILED。
SubReason
入力パラメーター。障害の詳細情報。
UserId
出力パラメーター。使用しません。
PassWord
出力パラメーター。使用しません。
CICS Transaction Gateway: プログラミング・リファレンス
EPI 出口
作成日付: 2005年12月2日
戻りコード
CICS_EXIT_OK
EPI は、この出口の出力として指定された値を使用して、
CICS_EpiAddTerminal または CICS_EpiAddExTerminal 呼び出しを再試行し
ます。この場合、 196 ページの『CICS_EpiAddTerminalExit』で説明している
考慮事項が適用されますので、注意してください。
CICS_EXIT_DONT_ADD_TERMINAL
CICS_EpiAddTerminal または CICS_EpiAddExTerminal が戻りコード
CICS_EPI_ERR_FAILED で終了します。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、出口が呼び出され
る原因となったエラーがアプリケーションに戻されます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、出口が呼び出される原因とな
ったエラーがアプリケーションに戻されます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、出口が呼び出される原因となったエラーがアプリケーションに戻さ
れます。
CICS_EpiTranFailedExit
関数名:
CICS_EpiTranFailedExit
パラメーター:
Anchor
TermIndex
Wait
Event
目的
トランザクションの異常終了または端末の障害があった場合に、ユーザーが、データを
収集できるようにします。
呼び出し時点
GetEventExit の有無に関係なく、イベントが CICS_EPI_EVENT_END_TRAN であり、
かつ AbendCode フィールドがブランク以外の場合の、CICS_EpiGetEvent が呼び出し
側に戻る直前。
第 5 章 ECI と EPI の出口
207
EPI 出口
作成日付: 2005年12月2日
リモート・システム上で起こり得る障害によっては、3270 データ・ストリームにエラ
ー・メッセージが表示されるだけで、CICS_EPI_EVENT_END_TRAN には異常終了コー
ドが現れない場合があることに注意してください。そのようなエラー・メッセージは、
CICS_EPI_EVENT_END_TRAN と同じイベントでは発生すらしないこともあります。出
口がこのような状態を処理する必要がある場合は、CICS_EpiGetEventExit を通してこ
の状態をモニターし、該当する 3270 データ・ストリームをスキャンします。
パラメーター
Anchor
入力パラメーター。CICS_EpiInitializeExit によってセットアップされ
たポインター。
TermIndex
入力パラメーター。この出口に関係のある CICS_EpiGetEvent 呼び出
しの TermIndex パラメーターでアプリケーションに戻される値。
Wait
入力パラメーター。この出口に関係のある CICS_EpiGetEvent 呼び出
しの Wait パラメーターに指定された値。
Event
入力パラメーター。この出口に関係のある CICS_EpiGetEvent 呼び出
しの Event パラメーターでアプリケーションに戻される値。
戻りコード
CICS_EXIT_OK
CICS_EpiGetEvent 呼び出しの処理は続きます。
CICS_EXIT_BAD_ANCHOR
CICS が無効なアンカー・フィールドを検出しました。EPI は、CICS
Transaction Gateway トレース・レコードを書き込んでから、
CICS_EpiGetEvent 呼び出しの処理を続けます。
CICS_EXIT_BAD_PARM
CICS が無効なパラメーターを検出しました。EPI は、CICS Transaction
Gateway トレース・レコードを書き込んでから、CICS_EpiGetEvent 呼び出し
の処理を続けます。
ユーザー定義のもの
ユーザー定義の戻りコードは、CICS_EXIT_USER_BASE 以上の値である必要
があります。 EPI は、CICS Transaction Gateway トレース・レコードを書き込
んでから、CICS_EpiGetEvent 呼び出しの処理を続けます。
208
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
付録 A. COM グローバル定数
定数は、クライアント・デーモン COM ライブラリーのタイプ・ライブラリーで提供さ
れています。ライブラリーは、CCLIECI.DLL および CCLIEPI.DLL にあります。
Visual Basic を使用している場合は、Visual Basic オブジェクト・ビューアーまたは別
のタイプのライブラリー・ビューアーを使用して、タイプ・ライブラリーの定義を調べ
ることができます。
VBScript を使用している場合は、タイプ・ライブラリーに定義されている列挙型はアク
セスできないため、ここに用意されている数値を使用してください。
例外コードの定数は、 219 ページの『付録 D. COM エラー・コードの解説』にリスト
があります。
© Copyright IBM Corp. 1989, 2005
209
作成日付: 2005年12月2日
210
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
付録 B. COM EPI 固有の定数
同期タイプ
表 4. 同期タイプ
VB 列挙型
値
説明
cclSync
0
同期呼び出しタイプ
cclDsync
1
遅延同期呼び出しタイプ
VB 列挙型
値
説明
cclEPIActive
0
EPI は初期化を完了。
cclDiscon
1
EPI が終了。
cclEPIError
2
EPI は初期化に失敗。例外処理の結果を参
照することで、詳細情報の確認可能。
VB 列挙型
値
説明
cclSessionIdle
0
アイドル状態。クライアントはトランザク
ションを開始する必要がある。
cclSessionServer
1
サーバー待ち状態。
ccISessionClient
2
クライアント・デーモンの応答待ち状態。
ccISessionDiscon
3
切断
ccISessionError
4
セッション・エラー。例外処理の結果を参
照することで、詳細情報の確認可能。
CclEPI の状態
表 5. CclEPI の状態
CclSession の状態
表 6. CclSession の状態
© Copyright IBM Corp. 1989, 2005
211
作成日付: 2005年12月2日
CclTerminal の状態
表 7. CclTerminal の状態
VB 列挙型
値
説明
cclInit
0
端末は定義済みだが、未インストール。
cclActive
1
端末は接続済み (未使用)
cclIdle
2
アイドル状態。クライアント・デーモン
はトランザクションを開始する必要があ
る。
cclServer
3
サーバー待ち状態。
cclClient
4
クライアントの応答待ち状態。
cclDiscon
5
切断
cclError
6
端末エラー。例外処理の結果を参照するこ
とで、詳細情報の確認可能。
CclTerminal ATI の状態
表 8. CclTerminal ATI の状態
VB 列挙型
値
説明
cclATIEnabled
0
ATI は許可されている。
cclATIDisabled
1
ATI は許可されていない。
CclTerminal EndTermReasons
表 9. CclTerminal ATI の状態
212
VB 列挙型
値
説明
cclSignoff
0
切断の要求、またはユーザーが端末をサイ
ンオフした。
cclShutdown
1
CICS サーバーがシャットダウンされた。
cclOutOfService
2
端末は使用停止に切り替えられた。
cclUnknown
3
不明な状態が発生。
cclFailed
4
端末は切断に失敗。
cclNotDiscon
5
端末は切断されていない。
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
CclTerminal サインオン・タイプ
表 10. CclTerminal サインオン・タイプ
VB 列挙型
値
説明
cclSignonCapable
0
端末はサインオン・トランザクションをサ
ポート。
cclSignonIncapable
1
端末はサインオン・トランザクションをサ
ポートしない。
cclSignonUnknown
2
端末サインオン機能は不明。
CclScreen AID キー・コード
表 11. CclScreen AID キー・コード
VB 列挙型
値
説明
cclEnter
0
Enter (実行) キー
cclClear
1
CLEAR キー
cclPA1
2
PA キー 1
cclPA2
3
PA キー 2
cclPA3
4
PA キー 3
cclPF1
5
PF キー 1
cclPF2
6
PF キー 2
cclPF3
7
PF キー 3
cclPF4
8
PF キー 4
cclPF5
9
PF キー 5
cclPF6
10
PF キー 6
cclPF7
11
PF キー 7
cclPF8
12
PF キー 8
cclPF9
13
PF キー 9
cclPF10
14
PF キー 10
cclPF11
15
PF キー 11
cclPF12
16
PF キー 12
cclPF13
17
PF キー 13
cclPF14
18
PF キー 14
cclPF15
19
PF キー 15
cclPF16
20
PF キー 16
付録 B. COM EPI 固有の定数
213
作成日付: 2005年12月2日
表 11. CclScreen AID キー・コード (続き)
VB 列挙型
値
説明
cclPF17
21
PF キー 17
cclPF18
22
PF キー 18
cclPF19
23
PF キー 19
cclPF20
24
PF キー 20
cclPF21
25
PF キー 21
cclPF22
26
PF キー 22
cclPF23
27
PF キー 23
cclPF24
28
PF キー 24
CclField 保護状態属性
表 12. CclField 保護状態属性
VB 列挙型
値
説明
cclProtect
0
保護フィールド (変更不可能)
cclUnprotect
1
無保護 (入力) フィールド
VB 列挙型
値
説明
cclAlphanumeric
0
英数字入力フィールド
cclNnumeric
1
数字入力フィールド
VB 列挙型
値
説明
cclNormal
0
通常表示
cclIntense
1
高輝度表示
cclDark
2
非表示フィールド
CclField 数値属性
表 13. CclField 数値属性
CclField 輝度属性
表 14. CclField 輝度属性
214
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
CclField 変更属性
表 15. CclField 変更属性
VB 列挙型
値
説明
cclUnmodified
0
フィールドは未変更。
cclModified
1
フィールドは変更された。
CclField 強調表示属性
表 16. CclField 強調表示属性
VB 列挙型
値
説明
cclHltDefault
0
デフォルトのフィールド・テキスト強調表
示
cclHltNormal
1
3270 基本属性の指定によるフィールド・
テキストの強調表示
cclHltBlink
2
テキストの明滅
cclHltReverse
3
反転表示テキスト
cclHltUnderscore
4
下線付きテキスト
cclHltIntense
5
高輝度テキスト
VB 列挙型
値
説明
cclTrnDefault
0
デフォルト (不透明) のフィールド背景
cclTrnOr
1
透過性のフィールド背景 (OR)
cclTrnXor
2
透過性のフィールド背景 (XOR)
cclTrnOpaque
3
不透明のフィールド背景
VB 列挙型
値
説明
cclDefaultColor
0
cclBlue
1
CclField 透過性属性
表 17. CclField 透過性属性
CclField カラー属性
表 18. CclField カラー属性
付録 B. COM EPI 固有の定数
215
作成日付: 2005年12月2日
表 18. CclField カラー属性 (続き)
216
VB 列挙型
値
cclRed
2
cclPink
3
cclGreen
4
cclCyan
5
cclYellow
6
cclNeutral
7
cclBlack
8
cclDarkBlue
9
cclOrange
10
cclPurple
11
cclPaleGreen
12
cclPaleCyan
13
cclGray
14
cclWhite
15
CICS Transaction Gateway: プログラミング・リファレンス
説明
作成日付: 2005年12月2日
付録 C. COM ECI 定数
同期タイプ
表 19. 同期タイプ
VB 列挙型
値
説明
cclSync
0
同期呼び出しタイプ
cclDsync
1
遅延同期呼び出しタイプ
VB 列挙型
値
説明
cclInactive
0
フローは非アクティブ。
cclLink
1
フローは現在リンク呼び出し中。
cclBackout
2
フローは現在 UOW をバックアウト中。
cclCommit
3
フローは現在 UOW をコミット中。
cclStatus
4
フローは状況を要求中。
cclChanged
5
フローは状況変更を要求中。
cclCancel
6
フローは状況取り消しを要求中。
VB 列挙型
値
説明
cclUnknown
0
CICS サーバー状況は不明。
cclAvailable
1
CICS サーバー状況は使用可能。
cclUnavailable
2
CICS サーバー状況は使用不可。
フロー状況タイプ
表 20. フロー状況タイプ
接続状況コード
表 21. 接続状況コード
© Copyright IBM Corp. 1989, 2005
217
作成日付: 2005年12月2日
218
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
付録 D. COM エラー・コードの解説
列挙型
値
説明
ECI
EPI
cclNoError
0
エラーは起こらなかった。
Ｏ
Ｏ
cclBufferOverflow
1
拡張可能ではない CclBuf オブジェクトを
拡張しようとした。
Ｏ
cclMultipleInstance
2
複数のオブジェクトを作成しようとした。
Ｏ
cclActiveFlow
3
現行フローはまだアクティブであり、この
フローは、非アクティブになるまで使用で
きない。
Ｏ
cclActiveUOW
4
現行の UOW がまだアクティブであり、バＯ
ックアウトまたはコミットが必要。
cclSyncType
5
メソッド呼び出しの同期タイプが誤り。
Ｏ
Ｏ
cclDataLength
9
CommArea が 32768 バイトより大きい、
またはインバウンド 3270 データ・ストリ
ームが端末バッファー・サイズに対して大
き過ぎる。
Ｏ
Ｏ
cclNoCICS
10
クライアント・デーモンが使用不可。また
は、サーバー・インプリメンテーションが
使用不可。あるいは、作業論理単位が開始
されるはずであったが、指定された CICS
サーバーが使用不可。リソースは更新され
ていない。
Ｏ
Ｏ
cclCICSDied
11
作業論理単位が開始または継続されるはずＯ
であったが、CICS サーバーが使用できな
かった。これがアクティブ UOW を用いた
リンク呼び出しの場合は、変更はバックア
ウトされる。これが、UOW コミットの場
合、または変更がコミットされたか、バッ
クアウトされたかをアプリケーションが判
別できない場合は、これ以降の手動リカバ
リーに備えて、この状態をログに記録して
おく必要がある。
cclNoReply
12
未解決の応答はない。
Ｏ
cclTransaction
13
ECI プログラムが異常終了。
Ｏ
cclSystemError
14
不明な内部エラーが生じた。
Ｏ
© Copyright IBM Corp. 1989, 2005
Ｏ
219
作成日付: 2005年12月2日
列挙型
値
説明
ECI
EPI
cclResource
15
サーバー・インプリメンテーションまたは
クライアント・デーモンには、要求を完了
するのに十分なリソースがなかった。すな
わち、SNA セッションが不十分。
Ｏ
Ｏ
cclMaxUOWs
16
新規の作業論理単位が作成されたが、アプ
リケーションには、構成がサポートしてい
る未解決の作業論理単位の数と同じだけの
作業論理単位がすでに存在している。
Ｏ
cclUnknownServer
17
要求されたサーバーは見つからなかった。
Ｏ
Ｏ
cclSecurity
18
サーバーはユーザー ID とパスワードの有
効な組み合わせを予想していたが、指定さ
れなかった。
Ｏ
Ｏ
cclMaxServers
19
構成で許可された数以上のサーバーに対し
て、要求を開始しようとした。使用できる
サーバー数を制御する方法については、使
用しているクライアント・デーモンまたは
サーバーの資料を参照。
Ｏ
Ｏ
cclMaxRequests
20
通信リソースが十分ではないため、要求を
満たすことができなかった。通信リソース
を制御する方法については、使用している
クライアント・デーモンまたはサーバーの
資料を参照。
Ｏ
Ｏ
cclRolledBack
21
作業論理単位をコミットしようとしたが、
サーバーは変更をコミットすることができ
ず、代わりに変更をバックアウトした。
Ｏ
cclParameter
22
指定したパラメーターの誤り。
Ｏ
Ｏ
cclInvalidState
23
オブジェクトは、メソッドを呼び出すのに
正しい状態ではない。すなわち、端末オブ
ジェクトは依然としてサーバー状態なの
に、データを送信しようとした。
Ｏ
Ｏ
ccltransId
24
疑似会話型トランザクションに対して、ヌ
ルのトランザクション ID が指定された、
または戻された。
Ｏ
cclInitEPI
25
EPI オブジェクトがない。あるいは、EPI
は正しく初期化できなかった。
Ｏ
cclConnect
26
端末を追加しようとして、予期しないエラ
ーが生じた。
Ｏ
ccldata stream
27
サポートされないデータ・ストリーム
Ｏ
220
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
列挙型
値
説明
cclInvalidMap
28
マップ定義と画面が一致しない。
cclClass
29
不明な内部クラス・エラーが生じた。
cclStartTranFailure
30
トランザクションの開始が失敗した。
cclTimeout
31
サーバーからの応答の前に、タイムアウト
になった。
Ｏ
Ｏ
cclNoPassword
32
オブジェクトのパスワードがヌル。
Ｏ
Ｏ
cclNoUserid
33
オブジェクトのユーザー ID がヌル。
Ｏ
Ｏ
cclNullNewPassword
34
指定されたパスワードがヌル。
Ｏ
Ｏ
cclPemNotSupported
35
CICS サーバーは、パスワード有効期限管
理機能をサポートしていない。このメソッ
ドを使用できない。
Ｏ
Ｏ
cclPemNotActive
36
パスワード有効期限管理機能がアクティブ
ではない。
Ｏ
Ｏ
cclPasswordExpired
37
パスワードの有効期限が切れた。情報は戻
されない。
Ｏ
Ｏ
cclPasswordInvalid
38
パスワードが無効。
Ｏ
Ｏ
cclPasswordRejected
39
パスワードが定義された標準に準拠してい
ないため、パスワード変更が失敗した。
Ｏ
Ｏ
cclUseridInvalid
40
ユーザー ID が不明。
Ｏ
Ｏ
cclInvalidTermid
41
端末 ID が無効。
Ｏ
cclInvalidModelId
42
モデル/タイプが無効。
Ｏ
cclnot3270
43
3270 装置ではない。
Ｏ
cclinvalidCCSId
44
CCSid が無効
Ｏ
cclServerBusy
45
CICS サーバーは使用中。
Ｏ
cclSignonNotPoss
46
サーバーは、端末リソースをサインオン対
応としてインストールすることは許可しな
い。
Ｏ
ECI
EPI
Ｏ
Ｏ
Ｏ
Ｏ
付録 D. COM エラー・コードの解説
221
作成日付: 2005年12月2日
222
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
付録 E. Java エンコード方式
この付録では、サポートされる Java エンコード方式のリストを示しています。どのコ
ード・ページにデータ・ストリームがあるかを CICS サーバーが、判別できるように、
正規名が対応する CCSid に変換されます。
注:
1. エンコード方式をインプリメントするためには、ご使用の CICS サーバーが EPI バ
ージョン 2 をサポートしている必要があります。
2. CICS サーバーの資料を調べて、ご使用のサーバーがサポートしている CCSids を確
認してください。
正規名
説明
CCSid
Cp1252
Windows Latin-1
5348
ISO8859_1
ISO 8859-1、Latin アルファベット No.1
819
UTF8
8 ビット Unicode 変換形式
1208
ASCII
ASCII コード
437
Big5
Big 5、中国語 (繁体字)
950
Cp037
米国、カナダ (バイリンガル、フランス語)、オランダ、ポルトガ 37
ル、ブラジル、オーストラリア
Cp273
IBM オーストリア、ドイツ
273
Cp277
IBM デンマーク、ノルウェー
277
Cp278
IBM フィンランド、スウェーデン
278
Cp280
IBM イタリア
280
Cp284
IBM カタロニア語/スペイン、スペイン語圏ラテンアメリカ
284
Cp285
IBM 英国、アイルランド
285
Cp297
IBM フランス
297
Cp420
IBM アラビア語
420
Cp424
IBM ヘブライ語
424
Cp437
MS-DOS 米国、オーストラリア、ニュージーランド、南アフリカ 437
Cp500
EBCDIC 500V1
500
Cp838
IBM タイ拡張 SBCS
9030
Cp850
MS-DOS Latin-1
850
Cp852
MS-DOS Latin-2
852
© Copyright IBM Corp. 1989, 2005
223
Java エンコード方式
作成日付: 2005年12月2日
正規名
説明
CCSid
Cp855
IBM キリル文字
855
Cp856
IBM ヘブライ語
856
Cp857
IBM トルコ語
857
Cp858
ユーロ文字を用いた Cp850 の変種
858
Cp862
PC ヘブライ語
862
Cp864
PC アラビア語
864
Cp865
MS-DOS 北欧ゲルマン系言語
865
Cp866
MS-DOS ロシア語
866
Cp868
MS-DOS パキスタン
868
Cp869
IBM 現代ギリシャ語
869
Cp870
IBM マルチリンガル Latin-2
870
Cp871
IBM アイスランド
871
Cp874
IBM タイ語
9066
Cp875
IBM ギリシャ語
875
Cp918
IBM パキスタン (ウルドゥー語)
918
®
Cp921
IBM ラトビア、リトアニア (AIX , DOS)
921
Cp922
IBM エストニア (AIX, DOS)
922
Cp923
IBM Latin-9
923
Cp930
日本語カタカナ - 漢字と 4370 UDC の混合 (5026 のスーパーセ 930
ット)
Cp933
韓国語と 1880 UDC の混合 (5029 のスーパーセット)
933
Cp935
中国語 (簡体字) ホストと 1880 UDC の混合 (5031 のスーパー
セット)
935
Cp937
中国語 (繁体字) ホストと 6204 UDC の混合 (5033 のスーパー
セット)
937
Cp939
日本語英数小文字漢字と 4370 UDC の混合 (5035 のスーパーセ
ット)
939
Cp942
IBM OS/2® 日本語 (Cp932 のスーパーセット)
942
Cp942C
Cp942 の変種
942
Cp943
IBM OS/2 日本語 (Cp932 およびシフト JIS のスーパーセット)
943
Cp943C
Cp943 の変種
943
Cp948
OS/2 中国語 (繁体字)(938 のスーパーセット)
948
Cp949
PC 韓国語
949
Cp949C
Cp949 の変種
949
224
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
Java エンコード方式
正規名
説明
CCSid
Cp950
PC 中国語 (香港、台湾)
950
Cp964
AIX 中国語 (繁体字)
964
Cp970
AIX 韓国語
970
Cp1006
IBM AIX パキスタン (ウルドゥー語)
1006
Cp1025
IBM マルチリンガル・キリル文字: ブルガリア、ボスニア、ヘル 1025
ツェゴビナ、マケドニア (FYR)
Cp1026
IBM Latin-5、トルコ
1026
Cp1097
IBM イラン/ペルシア語
1097
Cp1098
IBM イラン/ペルシア語
1098
Cp1112
IBM ラトビア、リトアニア
1112
Cp1122
IBM エストニア
1122
Cp1123
IBM ウクライナ
1123
Cp1124
IBM AIX ウクライナ
1124
Cp1140
ユーロ文字を用いた Cp037 の変種
1140
Cp1141
ユーロ文字を用いた Cp273 の変種
1141
Cp1142
ユーロ文字を用いた Cp277 の変種
1142
Cp1143
ユーロ文字を用いた Cp278 の変種
1143
Cp1144
ユーロ文字を用いた Cp280 の変種
1144
Cp1145
ユーロ文字を用いた Cp284 の変種
1145
Cp1146
ユーロ文字を用いた Cp285 の変種
1146
Cp1147
ユーロ文字を用いた Cp297 の変種
1147
Cp1148
ユーロ文字を用いた Cp500 の変種
1148
Cp1149
ユーロ文字を用いた Cp871 の変種
1149
Cp1250
Windows 東ヨーロッパ
5346
Cp1251
Windows キリル文字
5347
Cp1253
Windows ギリシャ語
5349
Cp1254
Windows トルコ語
5350
Cp1255
Windows ヘブライ語
5351
Cp1256
Windows アラビア語
5352
Cp1257
Windows バルト語
5353
Cp1258
Windows ベトナム語
5354
Cp1381
IBM OS/2、 DOS 中華人民共和国 (PRC)
1381
Cp1383
IBM AIX 、中華人民共和国 (PRC)
1383
付録 E. Java エンコード方式
225
Java エンコード方式
作成日付: 2005年12月2日
正規名
説明
CCSid
EUC_CN
GB2312、EUC エンコード方式、中国語 (簡体字)
1383
EUC_JP
JIS X 0201、0208、0212、EUC エンコード方式、日本語
954
EUC_KR
KS C 5601、EUC エンコード方式、韓国語
970
GBK
GBK、中国語 (簡体字)
1386
ISO8859_2
ISO 8859-2 ローマ字アルファベット No.2
912
ISO8859_5
ISO 8859-5、ローマ字/キリル文字アルファベット
915
ISO8859_6
ISO 8859-6、ローマ字/アラビア語アルファベット
1089
ISO8859_7
ISO 8859-7、ローマ字/ギリシャ語アルファベット
813
ISO8859_8
ISO 8859-8、ローマ字/ヘブライ語アルファベット
916
ISO8859_9
ISO 8859-9 ローマ字アルファベット No.5
920
ISO8859_15_FDIS
ISO 8859-15 ローマ字アルファベット No.9
923
JIS0201
JIS X 0201、日本語
5050
JIS0208
JIS X 0208、日本語
5050
JIS0212
JIS X 0212、日本語
5050
EUC_TW
CNS 11643 (プレーン 1-3)、EUC エンコード方式、中国語 (繁体 964
字)
MS932
Windows 日本語
943
MS936
Windows 中国語 (簡体字)
1386
MS949
Windows 韓国語
1363
226
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
付録 F. C++ 例外オブジェクト
すべての例外オブジェクトは、以下の情報を提供します。
v クラス名
v メソッド名
v 例外コード
v 例外テキスト
v 異常終了コード (ECI のみ)
v 起点
クラス名には末尾に I を付けることができます。これは、既知のクラス内に含まれるク
ラスであることを意味します。たとえば、CclFlowI は CclFlow の中に含まれます。内
部クラスが報告された場合は、報告されるメソッドは外部メソッドではなく内部メソッ
ドである可能性があります。
起点は、例外が生成されたクラス・ライブラリー内の正確なポイントを定義する固有値
です。これらは主に保守の際に役立ちます。
より重要な情報項目は例外コード、例外テキスト、および異常終了コード (ECI のみ)
です。以下の表は、これらの例外コード、テキスト、およびそれらが ECI と EPI の片
方または両方と関連するかどうかを要約したものです。
表 22. 例外コード
列挙型
テキスト
説明
ECI
EPI
Ccl::noError
no error
エラーは起こらなかった。
Ｏ
Ｏ
Ccl::bufferOverflow
buffer overflow
拡張可能ではない CclBuf
オブジェクトを拡張しよう
とした。
Ｏ
Ccl::multipleInstance
multiple instance
複数のオブジェクトを作成
しようとした。
Ｏ
Ccl::activeFlow
flow is active
現行フローは、まだアクテ
ィブであり、非アクティブ
になるまでこのフローは使
用できない。
Ｏ
Ccl::activeUOW
UOW is active
現行の UOW がまだアクテ
ィブであり、バックアウト
またはコミットが必要。
Ｏ
© Copyright IBM Corp. 1989, 2005
227
作成日付: 2005年12月2日
表 22. 例外コード (続き)
列挙型
テキスト
説明
ECI
EPI
Ccl::syncType
sync error
メソッド呼び出しの同期タ
イプが誤り。
Ｏ
Ｏ
Ccl::threadCreate
thread create error
内部スレッド作成エラー。
Ｏ
Ｏ
Ccl::threadWait
thread wait error
内部スレッド待機エラー。
Ｏ
Ccl::threadKill
thread kill error
内部スレッド強制終了エラ
ー。
Ｏ
Ccl::dataLength
data length invalid
CommArea が 32768 バイトＯ
より大きい、またはインバ
ウンド 3270 データ・スト
リームが端末バッファー・
サイズに対して大きすぎ
る。
Ｏ
Ccl::noCICS
no CICS
ゲートウェイが使用不可。
または、サーバー・インプ
リメンテーションが使用不
可。あるいは、作業論理単
位が開始されるはずであっ
たが、指定された CICS サ
ーバーが使用不可。リソー
スは更新されていない。
Ｏ
Ｏ
Ccl::CICSDied
CICS died
Ｏ
作業論理単位が開始または
継続されるはずであった
が、CICS サーバーを使用で
きなかった。これがアクテ
ィブ UOW を用いたリンク
呼び出しの場合は、変更は
バックアウトされる。これ
が UOW コミットまたはバ
ックアウトの場合、アプリ
ケーションは変更がコミッ
トされたかバックアウトさ
れたかを判別できない。そ
のためアプリケーション
は、これ以降の手動リカバ
リーに備えて、この状態を
ログに記録しておく必要が
ある。
Ccl::noReply
no reply
未解決の応答はない。
228
CICS Transaction Gateway: プログラミング・リファレンス
Ｏ
作成日付: 2005年12月2日
表 22. 例外コード (続き)
列挙型
テキスト
説明
ECI
Ccl::transaction
transaction abend
ECI プログラムが異常終
了。
Ｏ
Ccl::systemError
system error
不明な内部エラーが生じ
た。
Ｏ
Ｏ
Ccl::resource
resource shortage
サーバー・インプリメンテ
ーションまたはゲートウェ
イには、要求を完了するの
に十分なリソースがなかっ
た。すなわち、SNA セッシ
ョンが不十分。
Ｏ
Ｏ
Ccl::maxUOWs
exceeded max UOWs
新規の作業論理単位が作成
されたが、アプリケーショ
ンには、構成がサポートし
ている未解決の作業論理単
位の数と同じだけの作業論
理単位がすでに存在してい
る。
Ｏ
Ccl::unknownServer
unknown server
要求されたサーバーが見つ
からなかった。
Ｏ
Ｏ
Ccl::security
security error
サーバーはユーザー ID と
パスワードの有効な組み合
わせを予想していたが、指
定されなかった。
Ｏ
Ｏ
Ccl::maxServers
exceeded max servers
構成で許可された数以上の
サーバーに対して、要求を
開始しようとした。使用で
きるサーバー数を制御する
方法については、使用して
いるゲートウェイまたはサ
ーバーの資料を参照。
Ｏ
Ｏ
Ccl::maxRequests
exceeded max requests
通信リソースが十分ではな
いため、要求を満たすこと
ができなかった。通信リソ
ースを制御する方法につい
ては、使用しているゲート
ウェイまたはサーバーの資
料を参照。
Ｏ
Ｏ
EPI
付録 F. C++ 例外オブジェクト
229
作成日付: 2005年12月2日
表 22. 例外コード (続き)
列挙型
テキスト
説明
ECI
Ccl::rolledBack
rolled back
作業論理単位をコミットし
ようとしたが、サーバーは
変更をコミットすることが
できず、代わりに変更をバ
ックアウトした。
Ｏ
Ccl::parameter
parameter error
指定したパラメーターの誤
り。
Ｏ
Ｏ
Ccl::invalidState
invalid object state
オブジェクトは、メソッド
を呼び出すのに正しい状態
ではない。すなわち、端末
オブジェクトは依然として
サーバー状態なのに、デー
タを送信しようとした。
Ｏ
Ｏ
Ccl::transId
invalid transaction
疑似会話型トランザクショ
ンに対して、ヌルのトラン
ザクション ID が指定され
た、または戻された。
Ｏ
Ccl::initEPI
EPI not initialized
EPI は正しく初期化するの
に失敗した。あるいは EPI
オブジェクトが欠落。
Ｏ
Ccl::connect
connection failed
端末を追加しようとして、
予期しないエラーが生じ
た。
Ｏ
Ccl::data stream
3270 data stream error
サポートされないデータ・
ストリーム
Ｏ
Ccl::invalidMap
map/screen mismatch
マップ定義と画面が一致し
ない。
Ｏ
Ccl::cclClass
CICS class error
不明な内部クラス・エラー
が生じた。
Ccl::startTranFailure
Start Transaction Failure
トランザクションが開始に
失敗した。
Ccl::timeout
Timeout Occurred
サーバーからの応答の前
に、タイムアウトになっ
た。
Ｏ
Ｏ
Ccl::noPassword
Password is Null
オブジェクトのパスワード
がヌル。
Ｏ
Ｏ
230
CICS Transaction Gateway: プログラミング・リファレンス
Ｏ
EPI
Ｏ
Ｏ
作成日付: 2005年12月2日
表 22. 例外コード (続き)
列挙型
テキスト
説明
Ccl::noUserid
Userid is Null
オブジェクトのユーザー ID Ｏ
がヌル。
Ccl::nullNewPassword
A NULL new password was 指定されたパスワードがヌ
supplied
ル。
Ｏ
Ｏ
Ccl::pemNotSupported
PEM is not supported on the CICS サーバーは、パスワーＯ
server
ド有効期限管理機能をサポ
ートしていない。このメソ
ッドは使用できない。
Ｏ
Ccl::pemNotActive
PEM is not active on the
server
パスワード有効期限管理機
能がアクティブではない。
Ｏ
Ｏ
Ccl::passwordExpired
Password has expired
パスワードの有効期限が切
れた。情報は戻されない。
Ｏ
Ｏ
Ccl::passwordInvalid
Password is invalid
パスワードが無効。
Ｏ
Ｏ
Ccl::passwordRejected
New password was rejected
パスワードが定義された標
準に準拠していないため、
パスワード変更が失敗し
た。
Ｏ
Ｏ
Ccl::useridInvalid
Userid unknown at server
ユーザー ID が不明。
Ｏ
Ｏ
Ccl:invalidTermid
Termid is invalid
端末 ID が無効。
Ｏ
Ccl:invalidModelid
Modelid is invalid
無効なモデル/装置タイプ
Ｏ
Ccl:not3270
Not a 3270 device
3270 装置ではない。
Ｏ
Ccl:invalidCCSid
Codepage (CCSid value) is
invalid
CCSid が無効
Ｏ
Ccl:serverBusy
Server is too busy
CICS サーバーは使用中。
Ｏ
Ccl:signonNotPossible
Signon Capable terminal is
not possible
サーバーは、端末リソース
をサインオン対応としてイ
ンストールすることは許可
しない。
Ｏ
ECI
EPI
Ｏ
付録 F. C++ 例外オブジェクト
231
作成日付: 2005年12月2日
232
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
製品ライブラリーおよび関連資料
この章では、CICS Transaction Gateway に関する資料、および関連トピックについてリ
ストしています。
CICS Transaction Gateway の資料
v CICS Transaction Gateway: Windows 管理、SC88-9383
この資料では、CICS Transaction Gateway for Windows の管理について説明していま
す。
v CICS Transaction Gateway: UNIX and Linux Administration, SC34-6372
この資料では、CICS Transaction Gateway for UNIX および Linux の管理について説
明しています。
v CICS Universal Client: Windows Administration, SC34-6369
この資料では、CICS Transaction Gateway for Windows の管理について説明していま
す。
v CICS Universal Client: UNIX and Linux Administration, SC34-6653
の資料では、Linux オペレーティング・システムでの CICS Transaction Gateway の管
理について説明しています。
v CICS Transaction Gateway: z/OS 管理、SD88-6663
この資料では、CICS Transaction Gateway for z/OS の管理について説明しています。
v CICS Transaction Gateway: Messages、SC34-6675
このオンライン・ブックは、CICS Transaction Gateway によって生成されるエラー・
メッセージをリストし、説明しています。
v CICS Transaction Gateway: プログラミング解説書、SD88-6665
この資料では、CICS Transaction Gateway でサポートされるプログラム言語の API
に関する情報を説明しています。
追加の HTML ページには、JAVA プログラミング上の参照情報があります。
v CICS Transaction Gateway: プログラミング・ガイド、SD88-6664
© Copyright IBM Corp. 1989, 2005
233
CICS Transaction Gateway
作成日付: 2005年12月2日
この資料は、CICS Transaction Gateway のプログラミングの入門書であり、クライア
ント/サーバー環境でユーザー・アプリケーションが CICS 機能を使用できるように
するために必要な情報を提供しています。
サンプル構成資料
いくつかのサンプル構成資料が、PDF 形式で使用可能です。これらの資料では、さまざ
まなプロトコルを使用して CICS サーバーと通信するために CICS Transaction Gateway
を構成する場合の段階的なガイダンスが示されています。これらの資料では、CICS
Transaction Gateway ライブラリーの情報を拡張して、詳細に説明されています。
次の Web サイト：
www.ibm.com/software/cics/ctg
にアクセスして、Library のリンクをたどってください。
Redbooks
次の International Technical Support Organization (ITSO) Redbook 資料には、クライアン
ト/サーバー構成の例が数多く記載されています。
v CICS Transaction Gateway V5 - The WebSphere® Connector for CICS, SG24-6133
v Revealed! Architecting Web Access to CICS, SG24-5466
v Enterprise JavaBeans™ for z/OS and OS/390® CICS Transaction Server V2.2,
SG24-6284
v Java Connectors for CICS: Featuring the J2EE Connector Architecture, SG24-6401. こ
の資料には、J2EE アプリケーションの開発に関する情報が記載されています。
|
|
v Systems Programmer’s Guide to Resource Recovery Services (RRS), SG24-6980-00. この
資料には、さまざまなシナリオで RRS を使用するための情報が記載されています。
|
|
|
v Communications Server for z/OS V1R2 TCP/IP Implementation Guide, SG24-6517-00。
この資料には、ロード・バランシングなど、Communications Server for z/OS V1R2
を使用するための情報が記載されています。
v Redpaper: Transactions in J2EE, REDP-3659-00。この Redpaper には、1 つのトラン
ザクションや XA トランザクションなど、 J2EE 環境でのトランザクションに関す
る議論が記載されています。
ITSO Redbooks™ については、いろいろなソースから入手できます。最新の情報につい
ては、次のサイトを参照してください。
www.ibm.com/redbooks/
234
CICS Transaction Gateway: プログラミング・リファレンス
その他の資料
作成日付: 2005年12月2日
その他の役に立つ資料
CICS Transaction Server の関連資料
CICS Transaction Server for z/OS RACF® Security Guide, SC34-6249
CICS の製品間通信
以下の資料では、CICS サーバー製品の相互通信機能について説明しています。
CICSファミリー: プロダクト間相互通信, SC88-9084
CICS Transaction Server for Windows V5.0 Intercommunication, SC34-6209
CICS Transaction Server for z/OS CICS 外部インターフェース・ガイド, SC88-9050
CICS Transaction Server for z/OS: 相互通信ガイド、SC88-9634
CICS/VSE® 2.3: Intercommunication Guide, SC33-0701
CICS Transaction Server for iSeries™ V5R2: Intercommunication, SC41-5456
TXSeries® 5.1: CICS Intercommunication Guide, SC34-4462
上記の最初の資料は、CICS 製品間相互通信について、プラットフォームとは独立した
概要を含んでいる CICS ファミリーの資料です。
CICS 問題判別関連資料
次の資料は、CICS サーバー製品の問題判別機能を説明したものです。
Transaction Server for Windows V5.0: Problem Determination, GC34-6210
CICS Transaction Server for z/OS V2.3 Problem Determination Guide, SC34-6239
CICS/VSE 2.3 Problem Determination Guide, SC33-0716
CICS Transaction Server for iSeries V5R2: Problem Determination, SC41-5453
TXSeries V5.1: CICS Problem Determination Guide, SC09-4465
CICS 製品に関する情報は、次の Web サイトに掲載されています。
www.ibm.com/software/cics/ctg
Microsoft Windows 関連資料
次の Web サイトを参照してください。
www.microsoft.com/windows
APPC 関連資料
IBM 製品
IBM Communications Server: 次の Web サイトを参照してください。
www.ibm.com/software/network/commserver/library
製品ライブラリーおよび関連資料
235
その他の資料
作成日付: 2005年12月2日
IBM パーソナル・コミュニケーションズ: 次の Web サイトを参照してくださ
い。
www.ibm.com/software/network/pcomm/library
Microsoft 製品
次の Web サイトを参照してください。
www.microsoft.com/hiserver/techinfo/productdoc/books.asp
ネットワーク体系 (SNA)
SNA Formats, GA27-3136
Systems Network Architecture Technical Overview, GC30-3073
Guide to SNA over TCP/IP, SC31-6527
TCP62 関連の資料
Multiprotocol Transport Networking (MPTN) Architecture: Technical Overview, GC31-7073
Multiprotocol Transport Networking (MPTN) Architecture: Formats, GC31-7074
IBM からの資料の入手方法
ダウンロードできる資料の情報については、次の Web サイトにアクセスしてくださ
い。
www.ibm.com/software/cics/ctg
その後、Library のリンクをたどってください。
236
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
アクセシビリティ
CICS Transaction Gateway の英語版は、アクセシビリティに関してテスト済みです。こ
の製品は、この章に記載されている記述に従えば、アクセシビリティのある製品です。
資料
資料の HTML バージョンに関しては、Eclipse InfoCenter を参照してください。
EPITerminal プロパティーのプログラマチック設定
EPITerminal 端末のプロパティー・シートはアクセス可能ではありません。プロパティ
ーをプログラマチックに設定するには、EPITerminal オブジェクトの getTerminal() メソ
ッドを使用して、端末オブジェクトにキャストします。たとえば、epiTerm が
EPITerminal オブジェクトの場合、次のようにコーディングします。
Terminal term = (Terminal)epiTerm.getTerminal();
次に、この端末オブジェクトに対してメソッドを使用すると、プロパティーを設定する
ことができます。 CICS サーバーに YOURSERV という名前を設定するには、次のように
コーディングします。
term.setServerName("YOURSERV");
この setter メソッドの詳細については、製品に付属している Javadoc を参照してくださ
い。
cicsterm
cicsterm は、アクセス可能ですが、アクセス可能な 3270 画面の定義を処理するアプリ
ケーションに依存しています。
cicsterm の最終行には、状況情報が含まれています。以下のリストは、左から右へ表示
される順に、この情報を示しています。
状況 (Status)
たとえば、cicsterm がサーバーに接続中は、1B が表示されます。 1 から 3 列目に
表示されます。
端末名 (Terminal name)
LU Name とも呼ばれます。4 列目から 7 列目です。
© Copyright IBM Corp. 1989, 2005
237
作成日付: 2005年12月2日
アクション (Action)
たとえば、X-System は、 cicsterm がサーバーからの応答待ちのため、端末のウィン
ドウへテキストを入力できないことを示しています。 9 列目から 16 列目です。
エラー番号 (Error number)
CICS Transaction Gateway に関連するフォーム CCLNNNN のエラー。17 列目から
24 列目です。
サーバー名 (Server name)
cicsterm が接続されるサーバー。 27 列目から 35 列目です。
大文字 (Upper case)
シフト・キーを押すと上矢印が表示されます。42 列目です。
キャップス・ロック (Caps Lock)
キャップス・ロックがオンの場合は大文字の A が表示されます。43 列目です。
挿入オン (Insert on)
テキストを挿入すると、既存のテキストが上書きされずに、脱字記号 (^) が表示さ
れます。脱字記号を見るのが困難な場合は、フォントの書体とサイズを変更するか、
または画面拡大機能を使って状況表示行のサイズを大きくしてください。 52 列目で
す。
カーソル位置 (Cursor position)
ROW/COLUMN の形式のカーソル位置です。ROW (行) は 2 桁の数値、COLUMN
(列) は 3 桁の数値です。画面の左上は、01/001 となります。 75 列目から 80 列目
です。
注: スクリーン・リーダー (読み上げソフトウェア) が、カーソル位置の最後の桁だ
けしか読み取らない場合は、スクリーン・リーダーのデフォルトの動作を変更す
る必要があることがあります。スクリーン・リーダーをカスタマイズして、状況
行の 75 列目から 80 列目が 1 つのフィールドとして扱われるように指定しま
す。これによって、いずれの桁が変更されても、全領域が読み取れるようになり
ます。
cicsterm -? コマンド
cicsterm -? コマンドを出した後、上矢印キーを使って「OK」ボタンからメッセージの
リストに移動します。メッセージからメッセージへ移動するには、上矢印キーと下矢印
キーを使用します。完了したならば、Tab キーを押してから Enter キーを押します。
端末サーブレット
端末サーブレットは、screen 表示可能プロパティーを使用することによって、どのよ
うな 3270 画面でも HTML として表現することができます。これは、あらゆる種類の
3270 画面を扱う設計になっているため、表現しようとする 3270 画面によっては、生成
される HTML がアクセス不能と見なされる可能性があります。表示可能プロパティー
238
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
である screen は、明示的に入力フィールドをラベル付けすることはありません。もし
そのように構成されている場合は、指定された 3270 フィールドのカラーを模倣するこ
とはできます。アプリケーションが端末サーブレット機能を使用して、アクセス可能で
あるかどうかをテストするのは、アプリケーション開発者の責任です。画面表示可能プ
ロパティーを使用する際に、3270 画面に必要な HTML が HTML ページから提供され
ない場合は、アプリケーションが、端末サーブレットの画面ハンドラー Bean とペー
ジ・マッピング機能を用いて、明示的にその 3270 画面を処理する必要があります。
アクセシビリティ
239
作成日付: 2005年12月2日
240
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
用語集
この用語集には、CICS Transaction Gateway ライ
ブラリーで使用されている特殊用語が定義してあ
ります。
［ア行］
アプリケーション ID (application identifier). そ
の名前によって論理装置が VTAM ネットワーク
内で識別される。 CICS アプリケーション ID
は、その APPLID システム初期設定パラメータ
ーに指定される。
アプリケーション ID (applid). アプリケーショ
ン ID (application identifier) を参照。
アプリケーション・プログラミング・インターフ
ェース (API) (application programming interface
(API)). 高水準言語で作成されたアプリケーショ
ン・プログラムが、特定のデータや、オペレーテ
ィング・システムまたは別のプログラムの機能を
使用するための手段となる機能インターフェー
ス。
アプレット (applet). 小さいアプリケーション・
プログラムで、特定のタスクを実行し、通常、オ
ペレーティング・システム間で移植可能。しばし
ば、Java を使用して作成され、アプレットは、イ
ンターネットからダウンロードし Web ブラウザ
ーで実行する。サーブレット (servlet) も参照。
暗号化 (encryption). 元のデータを入手するに
は、暗号化解除プロセスを使用する以外にない方
法で、データを理解できない形式に変換する処
理。
イーサネット (Ethernet). ローカル・エリア・ネ
ットワークの 1 つ。これを使用すると、複数の
ステーションが事前の調整を必要としないで、随
意に伝送メディアにアクセスすることができ、キ
© Copyright IBM Corp. 1989, 2005
ャリア・センスおよび遅延伝送の使用によってコ
ンテンションが回避され、衝突検出の使用によっ
てコンテンションが解決される。イーサネットで
は、キャリア・センス多重アクセス/衝突検出
(CSMA/CD) を使用する。
インターオペラビリティー (interoperability). 機
能単位固有の特性について、ユーザーがほとん
ど、もしくはまったく知識をもつ必要がないよう
な方法で、さまざまな機能単位間での通信、プロ
グラムの実行、またはデータの転送ができる機
能。
インターネット・プロトコル (IP) (Internet
Protocol (IP)). TCP/IP において、インターネッ
ト環境でデータを送信元から宛先に送付するプロ
トコル。
エミュレーション・プログラム (emulation
program). ホスト・システムがワークステーショ
ンとそれがエミュレートされた端末であるかのよ
うに通信することができるようにするプログラ
ム。
エミュレーター (emulator). コンピューターを他
のシステムに接続されたワークステーションとし
て作動させるプログラム。
エンタープライズ Bean (enterprise bean). Java
コンポーネントで、他のリソースと結合して
J2EE アプリケーションを作成できる。エンティ
ティー Bean、セッション Bean、およびメッセー
ジ駆動型 Bean の 3 種類のエンタープライズ
Bean がある。
応答単位 (RU) (response unit (RU)). 要求単位
を確認するメッセージ単位で、要求単位で受信し
た接頭部情報が含まれる場合もある。
241
用語集
作成日付: 2005年12月2日
応答ファイル (response file). プログラムが尋ね
てくる質問に対する事前定義応答集が入ってい
て、ユーザー・ダイアログの代わりに使用される
ファイル。CID 方法論 (CID methodology) を参
照。
外部セキュリティー・インターフェース (ESI)
(external security interface (ESI)). クライアン
ト・アプリケーションで、CICS サーバー上のユ
ーザー ID に対応するパスワードを検査および変
更できるようにする機能。
オブジェクト (object). オブジェクト指向プログ
ラミングにおいて、データとデータに関連した操
作から成るクラスを具現化したもの。
外部表示インターフェース (EPI) (external
presentation interface (EPI)). 非 CICS プログラ
ムが、1 つ以上の標準 3270 端末として CICS に
表示されることができるようにする機能。3270
データは、3270 端末をエミュレートすることに
よって、もしくはグラフィカル・ユーザー・イン
ターフェースを使用することによって、ユーザー
に対して表示できる。
オブジェクト指向 (OO) (object-oriented (OO)).
オブジェクトをサポートするコンピューター・シ
ステムまたはプログラム言語をいう語。
折り返しトレース. 最大クライアント折り返しサ
イズの設定が 0 より大きい構成。クライアン
ト・デーモン・バイナリー・トレース・ファイル
の合計サイズは、最大クライアント折り返しサイ
ズ (Maximum Client wrap size) の設定に指定さ
れた値までに限定される。標準入出力トレースの
場合、cicscli.bin および cicscli.wrp という
2 つのファイルが使用される。どちらも、最大ク
ライアント折り返しサイズ (Maximum Client
wrap size) の半分までのサイズにすることができ
る。
外部呼び出しインターフェース (ECI) (external
call interface (ECI)). 非 CICS プログラムによ
る CICS プログラムの実行を可能にする機能。デ
ータは、通常の CICS プログラム間通信の場合と
同様に、COMMAREA で交換が行われる。
会話 (conversation). 1 つのセッションを使用し
た 2 つのプログラムの接続。これにより、両プ
ログラムは、1 つのトランザクションを処理して
いる中に相互間で通信できる。
会話セキュリティー (conversation security).
APPC において、接続を確立する前に、ユーザー
ID またはグループ ID、およびパスワードの検証
ができるようにする処理。
［カ行］
外部 CICS インターフェース (EXCI) (external
CICS interface (EXCI)). CICS Transaction
Server for z/OS が提供する MVS アプリケーショ
ン・プログラミング・インターフェースで、非
CICS プログラムが CICS プログラムを呼び出し
たり、 COMMAREA を使用してデータを送受信
できるようにする。 CICS アプリケーション・プ
ログラムは、別の CICS プログラムのリンク先で
あるものとして呼び出される。 EXCI は、CICS
Transaction Gateway for z/OS による通信インター
フェースとして使用される。外部呼び出しインタ
ーフェース (ECI) External Call Interface (ECI) と
比較。
242
鍵リング. JSSE プロトコルにおいて、公開鍵、
秘密鍵、トラステッド・ルート、および証明書を
含むファイル。
拡張 2 進化 10 進コード (EBCDIC) (Extended
binary-coded decimal interchange code
(EBCDIC)). テキスト・データの表記用として開
発された 256 の 8 ビット文字から成るコード化
文字セット。
|
|
|
拡張作業論理単位 (extended logical unit of
work). 同じ CICS サーバーに対して出された一
連の ECI 要求にまたがる作業論理単位。
CICS Transaction Gateway: プログラミング・リファレンス
用語集
作成日付: 2005年12月2日
しインターフェース、外部表示インターフェース
および外部セキュリティー・インターフェース
を参照。
拡張プログラム間通信機能 (APPC) (Advanced
program-to-program communication (APPC)).
SNA/SDLC LU 6.2 プロトコルのインプリメンテ
ーションの 1 つ。相互接続されたシステムどう
しが通信およびプログラムの処理を共有できる。
クライアント・デーモンでは、APPC を使用し
て、CICS サーバー・システムと通信する。
クライアント/サーバー (client/server). ある 1
つのコンピューター上のプログラムが、別のコン
ピューター上のプログラムに要求を送ってから応
答を待つことになる分散データ処理での対話のモ
デルを言う語。要求側のプログラムをクライアン
トと呼び、応答側のプログラムをサーバーと呼
ぶ。
カラー・マッピング・ファイル (color mapping
file). クライアント・ワークステーション上で
3270 画面のカラー属性をカスタマイズするのに
使用されるファイル。
クライアント・アプリケーション (Client
application). サポートされているプログラム言語
(Java を除く) で書かれており、クライアント
API を使用するユーザー・アプリケーション。
環境変数 (environment variable). 処理の稼働環
境を指定する変数。たとえば、環境変数では、ホ
ーム・ディレクトリー、コマンド検索パス、使用
中の端末、および現在時間帯を記述できる。
クライアント・デーモン. クライアント・デーモ
ン (プロセス cclclnt) は、 UNIX、 Windows お
よび Linux 上にのみ存在する。 CICS サーバー
へのネットワーク接続を管理する。クライアン
ト・デーモンは、ECI、EPI、および ESI 要求を
処理し、CICS サーバーとの間で適切なフローの
送受信を行って、アプリケーションの要求を満た
す。その構成には、ctg.ini の CLIENT セクシ
ョンを使用する。
管理対象外モード (nonmanaged mode). アプリ
ケーションが Connection Factory の生成と構成を
担う環境。J2EE サーバーは、このような
Connection Factory を所有も認識もしないので、
サービス品質の機能は提供されない。
管理対象モード (managed mode). J2EE サーバ
ーでセットアップされた Connection Factory から
接続が取得される環境を言う語。このような接続
は、J2EE サーバーによって所有される。
クラス (class). オブジェクト指向プログラミング
において、共通の定義を持ち、したがって、プロ
パティー、操作、および振る舞いが共通であるオ
ブジェクトを作成する場合にインスタンスを生成
できるモデルまたはテンプレート。オブジェクト
は、クラスのインスタンスの 1 つ。
キーボード・マッピング (keyboard mapping).
キーボード上のキーと表示画面に表示される文
字、もしくはキーを押したときにプログラムが起
こすアクションとの間の対応を設定するリスト。
機密保護機能のある HTTP (Hypertext Transfer
Protocol Secure). ハイパーメディア文書をイン
ターネット経由で安全に転送し表示するために、
WWW サーバーと Web ブラウザーによって使用
される TCP/IP プロトコル。
クライアント API (Client API). クライアン
ト・デーモンの機能を用いて、クライアント・
アプリケーションが CICS のサービスを呼び出
すために使用するインターフェース。外部呼び出
クラスパス (classpath). 実行環境における環境変
数のキーワード。クラスおよびリソース・ファイ
ルを探すためのディレクトリーを指定する。
|
|
|
|
|
グローバル・トランザクション (global
transaction). 分散トランザクション処理環境で 1
つ以上のリソース・マネージャーによって実行さ
れ、外部トランザクション・マネージャーによっ
て調整されるリカバリー可能な作業単位。
用語集
243
用語集
作成日付: 2005年12月2日
ゲートウェイ (gateway). 2 つのシステムまたは
ネットワークを接続するために使用される装置ま
たはプログラム。
りも地理的に広い地域に通信サービスを提供し、
公衆通信施設の使用や提供ができるネットワー
ク。
ゲートウェイ・クラス (gateway classes). CICS
でのサービスを呼び出すために Java クライアン
ト・アプリケーションが使用する Java クラス・
ライブラリー。
構成ファイル. プログラム、システム装置、サー
バー、またはネットワークの特性を指定するファ
イル。
ゲートウェイ・グループ (Gateway group). 1 つ
のctgmaster のサービスを使用するゲートウェ
イ・デーモン・インスタンスのコレクション。こ
のグループは、XA トランザクションでの TCP/IP
ロード・バランシング機能を提供する。
ゲートウェイ・デーモン (gateway daemon). リ
モート・モードのみで使用される長時間実行の
Java プロセス。ゲートウェイ・デーモンは、リモ
ート Java クライアント・アプリケーションから
のネットワーク要求を listen する。
UNIX、Windows および Linux プラットフォーム
上でクライアント・デーモンの機能、または
z/OS 上で EXCI を使用して、CICS に対してこ
れらの要求を出す。ゲートウェイ・デーモンは、
プロトコル・リスナー・スレッド、接続マネージ
ャー・スレッド、および Worker スレッドを実行
する。その構成には、ctg.ini の GATEWAY セ
クション (および z/OS では STDENV ファイル
または ctgenvvar スクリプト) を使用する。
コード・ページ (code page). 図形文字への 16
進数 ID (コード・ポイント) の割り当て。特定の
コード・ページ内では、コード・ポイントは 1
つの意味しかもてない。
コールバック (callback). ある 1 つのスレッド
から別のアプリケーション・スレッドにイベント
の発生を知らせるための手段。
広域ネットワーク (WAN) (wide area network
(WAN)). ローカル・エリア・ネットワークや大
都市圏ネットワークによるサービスの対象地域よ
244
|
|
|
|
|
|
|
|
コミット・フェーズ (commit phase). XA 処理
の 2 番目のフェーズ。すべての参加プログラム
がコミットする準備が完了したことを確認する
と、トランザクション・マネージャーはコミット
要求を出す。コミットの準備を完了していない参
加プログラムがある場合、トランザクション・マ
ネージャーはすべての参加プログラムに対し、バ
ックアウト要求を出す。
|
|
|
|
|
|
コンテナー管理対象トランザクション
(container-managed transaction). EJB コンテナ
ーがコミットまたはロールバックなどのタスクの
管理を行うトランザクション。Bean 管理対象ト
ランザクション (bean-managed transaction) も参
照。
［サ行］
サーブレット (servlet). Web サーバー上で実行
される Java プログラムの 1 つで、Web クライ
アント要求に応答して動的コンテンツを生成する
ことにより、サーバーの機能を拡張する。サーブ
レットは、一般にデータベースを Web に接続す
ることに使用される。
サインオン対応端末 (signon capable terminal).
サインオン対応端末では、サインオン・トランザ
クションが、CICS 提供 (CESN)、またはユーザー
作成のいずれでも実行できる。サインオン非対応
端末 (signon incapable terminal) と対比。
作業単位 (UOW) (unit of work (UOW)). 2 つ
の一貫性ポイントにはさまれてアプリケーション
が実行する一連のリカバリー可能な操作。作業単
位が開始するのは、トランザクションの開始時点
またはユーザー要求の同期点においてである。そ
CICS Transaction Gateway: プログラミング・リファレンス
用語集
作成日付: 2005年12月2日
|
|
|
れは、ユーザー要求の同期点またはトランザクシ
ョンの終了時点で終了する。
ド数がトリガー・レベルに達した場合、指定され
たトランザクションが自動的に開始される。
作業論理単位 (LUW) (logical unit of work
(LUW)). CICS 内で実行されるリカバリー可能な
作業単位。
自動リスタート・マネージャー (automatic
restart manager). z/OS のリカバリー機能で、特
定のバッチ・ジョブまたは開始済みタスクの可用
性を向上させることができる。その結果、生産的
な作業がより高速に再開される。頭字語: ARM。
サブネット (subnet). IP アドレスによって識別
されるネットワークの相互接続されているが独立
したセグメント。
サブネット・アドレス (subnet address). インタ
ーネット通信において、基本 IP アドレッシング
方式の拡張で、ホスト・アドレスの一部がローカ
ル・ネットワーク・アドレスとして解釈される。
システム SSL (System SSL). SSL のインプリメ
ンテーションの 1 つで、 z/OS の CICS
Transaction Gateway は、すでにサポートを打ち切
っている。
システム初期設定テーブル (system initialization
table). CICS 制御領域を開始する場合に使用する
パラメーターが入るテーブル。
システム・ネットワーク体系 (SNA) (Systems
Network Architecture (SNA)). ネットワークを通
して情報単位を伝送するための、論理構造、フォ
ーマット、プロトコル、および操作シーケンスを
記述する体系で、ネットワークの構成および操作
を制御するための操作シーケンスも記述する。
従属論理装置 (dependent logical unit). システ
ム・サービス制御点 (SSCP) の助けをかりて
LU-LU セッションを活動化することができる論
理装置。
|
|
|
準備フェーズ (prepare phase). すべての参加プ
ログラムに対し、コミットの準備が完了している
か確認を要求する XA の 1 番目のフェーズ。
小数点付き 10 進表記 (dotted decimal
notation). 10 を基底として書かれた 4 つの 8
ビットの数をピリオド (ドット) で区切った構成
の 32 ビットの整数を表す構文表記。IP アドレス
の表記に使用する。
スレッド (thread). プログラム実行の基本単位。
幾つかのスレッドは、並行して異なるジョブを実
行しながら稼働することができる。
制御テーブル (control table). CICS において、
システムの構成および操作を記述または定義する
のに使用するストレージ域。
自動インストール (autoinstall). 端末ログオン時
に動的にリソースを作成およびインストールし、
ログオフ時にそれらを削除する方法。
セッション限度 (session limit). SNA において、
特定の論理装置 (LU) がサポートできる、並行ア
クティブ LU 間 (LU-LU) セッションの最大数。
自動トランザクション開始 (ATI) (automatic
transaction initiation (ATI)). 内部的に生成され
た要求によって CICS トランザクションを開始す
ること。例えば、EXEC CICS START コマンド
を発行する、または一時データがトリガー・レベ
ルに到達した場合。CICS リソース定義は、トリ
ガー・レベルとトランザクションを一時データ宛
先により関連付ける。宛先に書き込まれたレコー
セッション数変更 (CNOS)
(change-number-of-sessions (CNOS)). 内部トラン
ザクション・プログラムの 1 つで、特定の特性
を持つパートナー LU 間の並列セッションの数を
規制する。
接続 (attach). SNA において、会話を開始する
ためにセッション上を流れる要求単位。
用語集
245
用語集
接続 (connection). (1) データ通信における、機
能単位の間で情報を搬送するために確立されたア
ソシエーション。 (2) オープン・システム間相互
接続体系において、特定のレイヤーが、データ転
送を目的として、次に高いレイヤーの複数のエン
ティティーの間に確立するアソシエーション。
(3) TCP/IP において、信頼性の高いデータ・スト
リーム送達サービスを提供する、2 つのプロトコ
ル・アプリケーション間のパス。 (4) インターネ
ットにおいて、接続は、1 つのシステム上の TCP
アプリケーションから別のシステム上の TCP ア
プリケーションに達する。
|
|
|
|
作成日付: 2005年12月2日
タスク異常終了 (abend) (abnormal end of task
(abend)). リカバリー機能では解決できないエラ
ー条件が原因で生じるタスク、ジョブ、またはサ
ブシステムの終了。
端末エミュレーション (terminal emulation). マ
イクロコンピューターやパーソナル・コンピュー
ターが、処理装置にリンクされた特定のタイプの
端末と同じように動作し、データにアクセスでき
る機能。エミュレーター、エミュレーション・プ
ログラム (emulator, emulation program) も参照。
接続マネージャー (Attach Manager). リモー
ト・コンピューターから受信した接続をローカ
ル・プログラムが発行した受諾と突き合わせる
APPC のコンポーネント。
端末サーブレット (Terminal Servlet). Java プロ
グラムの 1 つで、これを使用すると、 Web ブラ
ウザーを任意の CICS サーバー上で稼働する
3270 CICS アプリケーションのエミュレーターと
して使用できる。
ソケット (socket). ネットワーク通信の概念で、
通常、クライアント、サーバー間の接続ポイント
を表す。 TCP/IP ソケットは、通常、ホスト名ま
たは IP アドレスとポート番号を結合する。
通信域 (COMMAREA) (communication area
(COMMAREA)). トランザクション内のプログ
ラム間とトランザクション間の両方でデータをや
り取りする場合に使用する通信域。
［タ行］
タイプ 2.0 ノード (type 2.0 node). サブエリ
ア・ネットワークに周辺ノードとして接続し、全
エンド・ユーザー・サービスを提供するが、中間
ルーティング・サービスを提供することはないノ
ード。
タイプ 2.1 ノード (type 2.1 node). ネットワー
ク内のエンドポイントまたは中間ルーティング・
ノードとして、もしくはサブエリア・ネットワー
クに接続される周辺ノードとして構成できる
SNA ノード。
タイムアウト (timeout). 操作が割り込まれるま
でに、イベントが発生するまたは完了するために
割り当てられた時間間隔。
データ・リンク制御 (DLC) (data link control
(DLC)). データ・リンク (たとえば、SDLC リン
クやトークンリングなど) 上のノードが、秩序立
った情報交換を実現するために使用する一連の規
則。
デーモン (daemon). ネットワーク制御など、連
続的または周期的な全システム機能を実行するた
めに無人で稼働するプログラム。デーモンは、オ
ペレーティング・システムの開始時などに自動的
に立ち上がるようにしてもよいし、手動で立ち上
げることもできる。
デジタル証明書 (digital certificate). 個人、サー
バー、会社、またはその他のエンティティーを識
別し、その公開鍵をそのエンティティーと関連付
けるために使用される電子文書。デジタル証明書
は、認証局により発行され、その認証局によりデ
ジタル署名されます。
デジタル署名 (digital signature). エンティティ
ーの秘密鍵によって暗号化し、メッセージに付加
246
CICS Transaction Gateway: プログラミング・リファレンス
用語集
作成日付: 2005年12月2日
トランザクション・プログラム (transaction
program). APPC アプリケーション・プログラミ
ング・インターフェース (API) を使用して、リモ
ート・システムにあるパートナー・アプリケーシ
ョン・プログラムと通信するプログラム。
して、メッセージの認証性と保全性を受信側に保
証する情報。デジタル署名では、メッセージが秘
密鍵または共有秘密対称鍵を所有する、もしくは
それにアクセスできるエンティティーによって署
名されたことを証明する。
トークンリング・ネットワーク (token-ring
network). リング・トポロジー上の装置を接続
し、トークン・パッシング・プロシージャーによ
り装置間の単一方向データ伝送ができるようにす
るローカル・エリア・ネットワーク。装置は、ト
ークンを受信してからデータ伝送が可能となる。
同期点 (sync point). プログラムによって加えら
れた変更が一貫化および完全化されて、コミット
できるようになる地点であるプログラムの実行の
論理点。この地点まで保留になっていた出力はそ
の宛先に送られ、入力はメッセージ・キューから
除去されて、他のアプリケーションが更新内容を
使用できるようになる。プログラムが異常終了し
た場合、CICS のリカバリーと再始動の機能は、
最後に完了した同期点より前の更新内容をバック
アウトしない。
独立論理装置 (independent logical unit). BIND
を送受信し、単一、並列、および複数セッション
をサポートすることができる論理装置
(LU)。BIND を参照。
ドメイン (domain). インターネットにおいて、
ネーミング階層の一部であり、そこではドメイ
ン・ネームがそれぞれの間をピリオド (ドット)
で区切った一連の名前 (ラベル) から成る。
ドメイン・ネーム (domain name). TCP/IP にお
いて、ネットワーク内のホスト・システムの名
前。
ドメイン・ネーム・サーバー (domain name
server). TCP/IP において、ドメイン・ネームを
IP アドレスにマップすることで、ネーム/アドレ
ス間変換を提供するサーバー・プログラム。ネー
ム・サーバー (name server) と同義。
|
|
|
|
|
|
トランザクション・マネージャー (transaction
manager). グローバル・トランザクションを管理
し、また変更をコミットするか、あるいはロール
バックするかの決定を調整することによって、リ
ソース・マネージャーのアクティビティーを調整
するトランザクションの参加プログラム。
トレース (trace). コンピューター・プログラム
の処理の記録。これは、命令が処理されたシーケ
ンスを示す。
［ナ行］
認証局 (certificate authority). コンピューター・
セキュリティーにおいて、証明書を発行する機
関。認証局は、証明書所有者の ID および同所有
者が使用を許可されたサービスを認証する。新規
証明書を発行し、証明書の使用許可を失ったユー
ザーの証明書を取り消す。
ネーム・サーバー (name server). TCP/IP では、
ドメイン・ネーム・サーバーの同義語。インター
ネット通信では、ネットワークとホストに割り当
てられたシンボル名を IP アドレスに変換するホ
スト。
ネットワーク名 (network name). SNA におい
て、エンド・ユーザーがネットワーク・アドレス
可能単位 (NAU)、リンク・ステーション、または
リンクを参照する場合に使用するシンボリック
ID。ネットワーク・アドレス (network address)
も参照。
ネットワーク・アドレス (network address).
SNA において、サブエリア・フィールドとエレ
メント・フィールドから成り、リンク、リンク・
ステーション、またはネットワーク・アドレス可
能単位 (NAU) を識別するアドレス。サブエリ
用語集
247
用語集
作成日付: 2005年12月2日
ア・ノードでは、ネットワーク・アドレスを使用
し、周辺ノードでは、ローカル・アドレスを使用
する。周辺ノードが接続されているサブエリア・
ノードの境界機能が、ローカル・アドレスからネ
ットワーク・アドレスへの変換、およびその逆の
変換を行う。ネットワーク名 (network name) も
参照。
し、サポートされているが推奨されない、将来的
に廃止される可能性のあるもの。
ネットワーク・アドレス可能単位 (NAU)
(network addressable unit (NAU)). SNA におい
て、論理装置、物理装置、またはシステム・サー
ビス制御点。NAU は、パス制御ネットワークに
よって伝送される情報の発信元または宛先。論理
装置 (logical unit)、ネットワーク・アドレス
(network address)、ネットワーク名 (network
name) も参照。
ファイアウォール (firewall). トラステッド・ネ
ットワークと非トラステッド・ネットワークの間
の無許可トラフィックを防止するソフトウェアの
構成。
ノード・タイプ (node type). SNA において、ノ
ードがサポートするプロトコル、およびノードに
含まれるネットワーク・アドレス可能単位 (NAU)
に応じたノードの指定。4 つのタイプ (1、2、4、
および 5) が定義されている。タイプ 1 とタイプ
2 のノードは、周辺ノードで、タイプ 4 とタイ
プ 5 のノードは、サブエリア・ノード。
［ハ行］
パートナー論理装置 (PLU) (partner logical unit
(PLU)). SNA において、セッションへのリモー
ト参加プログラム。
パートナー・トランザクション・プログラム
(partner transaction program). ローカル・トラ
ンザクション・プログラムとの APPC 会話に携
わっているトランザクション・プログラム。
ビジネス・ロジック (business logic). 分散アプ
リケーションの中で、ユーザー・インターフェー
スではなく、アプリケーション・ロジックにかか
わる部分。プレゼンテーション・ロジックと比
較。
標準エラー (standard error). 多くのワークステ
ーション・ベースのオペレーティング・システム
で、エラー・メッセージや診断メッセージが送信
される先の出力ストリーム。
吹き出しヘルプ (hover help). ユーザー・インタ
ーフェースのアイコンなどの項目上でマウスを押
さえたままにして表示できる情報。
プレゼンテーション・ロジック (presentation
logic). 分散アプリケーションの中で、アプリケ
ーションのユーザー・インターフェースにかかわ
る部分。ビジネス・ロジックと比較。
プログラム診断依頼書 (APAR) (Authorized
program analysis report (APAR)). 現行リリース
の IBM 提供プログラムの問題の修正を求める要
求。
プロトコル境界 (protocol boundary). ノード内
の 2 つのコンポーネントの対話を統轄する、シ
グナルおよび規則。
分散アプリケーション (distributed application).
コンポーネント・アプリケーション・プログラム
が複数の相互接続プロセッサー間に分散されてい
るアプリケーション。
分散処理 (distributed processing). 異なるシステ
ム内の同じアプリケーションの異なる部分を、1
つ以上のプロセッサーで処理すること。
分散プログラム・リンク (DPL) (distributed
program link (DPL)). 1 つの CICS システムで
稼働しているアプリケーション・プログラムが別
非推奨 (deprecated). プログラミング・エレメン
トまたはフィーチャーなどのエンティティーに属
248
CICS Transaction Gateway: プログラミング・リファレンス
用語集
作成日付: 2005年12月2日
の CICS システムで稼働しているアプリケーショ
ン・プログラムにリンクできるようにするリン
ク。
ホスト・アドレス (host address). ネットワーク
上のホストを識別するために使用される IP アド
レス。
ペーシング (pacing). 受信側端末が送信側端末の
伝送速度を制御して、オーバーランを防止する技
法。
［マ行］
並列セッション (parallel session). SNA におい
て、異なるネットワーク・アドレス対を使用して
いる 2 つの同じ LU 間で、並行してアクティブ
状態にある複数のセッション。各セッションごと
にそれぞれ独立したセッション・パラメーターが
もてる。
ポート (port). 装置間の通信のエンドポイント
で、一般的に論理接続を指す。特定の TCP/IP ノ
ード内の特定の TCP (Transmission Control
Protocol) または UDP (User Datagram Protocol)
リソースを識別する、16 ビットの数。
ホスト (host). ネットワーク (たとえば、インタ
ーネットや SNA ネットワークなど) に接続され
て、そのネットワークへのアクセス・ポイントに
なるコンピューター。どんなシステムでもホスト
になれ、メインフレームである必要はない。
ホスト ID (host ID). TCP/IP において、IP アド
レスのうちのネットワーク上のホストを定義する
部分。ホスト ID の長さは、ネットワークのタイ
プ、つまりネットワーク・クラス (A、B、C) に
応じて異なる。
ホスト名 (host name). インターネットのプロト
コル群において、コンピューターのドメイン・ネ
ーム。時には、ホスト名は、完全修飾ドメイン・
ネーム、他の時には、完全修飾ドメイン・ネーム
の特別な意味を持つ特定のサブネームを意味する
のに使用される。例えば、
mycomputer.city.company.com は、完全修飾ドメイ
ン・ネームである場合、次のどちらかは、ホスト
名と考えられる場合がある。
mycomputer.city.company.com、mycomputer
メソッド (method). オブジェクト指向プログラ
ミングにおいて、オブジェクトが実行できる操
作。1 つのオブジェクトは、多数のメソッドを持
つ。
メディア・アクセス制御 (MAC) サブレイヤー
(medium access control (MAC) sublayer). IEEE
のローカル・エリア・ネットワークに関するプロ
ジェクト 802 委員会と欧州電子計算機工業会
(ECMA) によってローカル・エリア・ネットワー
ク用として提唱された、ISO オープン・システム
間相互接続データ・リンク層のサブレイヤー 2
つのうちの 1 つ。ネットワークのトポロジーに
応じて異なる機能を提供し、物理層のサービスを
使用して、論理リンク制御 (LLC) サブレイヤー
にサービスを提供する。OSI データ・リンク層
は、SNA データ・リンク制御層に対応する。
モード (mode). SNA において、2 つの LU 間
のセッションの特性を定義する一組のパラメータ
ー。
［ヤ行］
ユーザー・セッション (user session).
SNASVCMG セッション以外のすべての APPC
セッション。
要求単位 (RU) (request unit (RU)). SNA にお
いて、要求コードなどの制御情報、または機能管
理 (FM) ヘッダー、エンド・ユーザー・データ、
もしくはその両方が含まれるメッセージ単位。
要求/応答単位 (request/response unit). 要求単位
または応答単位を表す総称用語。要求単位
(request unit) および応答単位 (response unit) を
参照。
用語集
249
用語集
［ラ行］
作成日付: 2005年12月2日
|
|
リカバリー単位 (UR) (unit of recovery (UR)).
RRS によって実行される定義済みの作業パッケー
ジ。
|
|
|
|
|
論理装置 (LU) (logical unit (LU)). SNA におい
て、エンド・ユーザーが別のエンド・ユーザーと
通信するために SNA ネットワークにアクセスす
る場合や、エンド・ユーザーがシステム・サービ
ス制御点 (SSCP) によって提供されている機能に
アクセスする場合に使用するポート。1 つの LU
は、少なくとも 2 つのセッション、つまり、
SSCP とのセッションと別の LU とのセッション
をそれぞれ 1 つずつサポートすることができ、
しかも他の論理装置とのセッションを数多くサポ
ートできる場合もある。ネットワーク・アドレス
可能単位 (network addressable unit)、1 次論理装
置 (primary logical unit)、2 次論理装置
(secondary logical unit) を参照。
リソース・マネージャー (resource manager). リ
カバリー可能リソースへのアクセスを制御するト
ランザクションの参加プログラム。 CICS リソー
ス・アダプターにおいて、これは
ConnectionFactory のインスタンスで表される。
リソース・リカバリー・サービス (RRS)
(Resource Recovery Services (RRS)). 参加して
いるリソース・マネージャー間で 2 フェーズ同
期点サポートを提供する z/OS 機能。
リモート・プロシージャー・コール (PRC)
(remote procedure call (RPC)). クライアント・
コンピューター上のプログラムがサーバー上のク
ライアントを実行可能にするプロトコル。
論理装置タイプ 6.2 (LU 6.2) (logical unit 6.2
(LU 6.2)). (1) 分散処理環境においてプログラム
相互の一般通信をサポートする論理装置のタイ
プ。 (2) APPC を使用する 2 つのアプリケーシ
ョン間のセッションをサポートする LU タイプ。
リモート・モード (remote mode). ゲートウェ
イ・デーモンへ接続するためにサポートされる
CICS Transaction Gateway ネットワーク・プロト
コルの 1 つの用途を記述した用語。ゲートウェ
イ・デーモンを参照。
［数字］
1 次論理装置 (PLU) (primary logical unit
(PLU)). SNA において、特定の LU 間セッショ
ンの 1 次側ハーフセッションの入った論理装
置。2 次論理装置 (secondary logical unit) も参
照。
領域 (region). CICS Transaction Gateway for
Windows のワークロード管理において CICS サ
ーバーのインスタンス。
|
|
|
|
ローカル・トランザクション (local transaction).
リソース・マネージャーによって管理されるが、
外部トランザクション・マネージャーによって調
整されないリカバリー可能な作業単位。
ローカル・モード (local mode). CICS
Transaction Gateway ローカル・プロトコルの使用
を記述した用語。ゲートウェイ・デーモンはロー
カル・モードでは使用されない。
作。この操作が完了すると、作業単位は終了す
る。「バックアウト」とも呼ばれる。
1 バイト文字セット (SBCS) (single-byte
character set (SBCS)). 各文字がそれぞれ 1 バ
イトで表される文字セット。2 バイト文字セット
と対比。
|
|
|
|
1 フレーズ・コミット. 単一のコミット・フェー
ズを使用したプロトコルで、単一のリソース・マ
ネージャーが関わるときに、リカバリー可能なリ
ソースへの変更を調整するために用いられる。
| ロールバック (rollback). 作業単位中に行われた
| すべての変更を無効にするトランザクションの操
250
CICS Transaction Gateway: プログラミング・リファレンス
用語集
作成日付: 2005年12月2日
2 次論理装置 (SLU) (secondary logical unit
(SLU)). SNA において、特定の LU 間セッショ
ンの 2 次側ハーフセッションが含まれる論理装
置 (LU)。1 次論理装置 (primary logical unit) と
対比。論理装置 (logical unit) も参照。
2 バイト文字セット (DBCS) (double-byte
character set (DBCS)). 各文字が 2 バイトで表
される文字のセット。日本語、中国語、および韓
国語などの言語には、256 のコード・ポイントで
は表し切れない数の記号が含まれているので、2
バイト文字セットが必要になる。各文字ごとに 2
バイトが必要なため、 DBCS 文字の入力、表
示、および印刷には、DBCS をサポートするハー
ドウェアおよびプログラムが必要である。1 バイ
ト文字セット (single-byte character set) と対比。
|
|
|
|
|
|
2 フレーズ・コミット. 準備フェーズとコミッ
ト・フェーズの両方を使用したプロトコルで、複
数のリソース・マネージャーが 1 つのトランザ
クションによって使用されるときに、リカバリー
可能なリソースへの変更を調整するために用いら
れる。
3270 エミュレーション (3270 emulation). クラ
イアントが IBM 3270 ディスプレイ装置またはプ
リンターをエミュレートし、 IBM ホスト・シス
テムの諸機能を使用するためのソフトウェアの使
用。
B
Bean. JavaBeans コンポーネントの定義またはイ
ンスタンス。JavaBeans を参照。
|
|
|
|
|
|
Bean 管理対象トランザクション (bean-managed
transaction). J2EE Bean 自体が、コミットまた
はロールバックなどのトランザクション・タスク
の管理を行うトランザクション。コンテナー管理
対象トランザクション (container-managed
transaction) も参照。
BIND コマンド (BIND command). SNA におい
て、2 つの論理装置 (LU) 間でセッションを活動
化するための要求。
C
CA.
認証局 (certificate authority) を参照。
CICS on System/390®. CICS Transaction Server
for z/OS、CICS for MVS/ESA™、CICS
Transaction Server for VSE/ESA™、および
CICS/VSE の各製品の一般的な呼称として使用す
る語。
CNOS. セッション数変更
(Change-Number-of-Sessions) を参照。
D
A
APAR.
プログラム診断依頼書を参照。
API. アプリケーション・プログラミング・イン
ターフェース。
ARM.
自動再始動管理を参照。
ATI. 自動トランザクション開始 (automatic
transaction initiation) を参照。
DBCS. 2 バイト文字セット (double-byte
character set) を参照してください。
DPL. 分散プログラム・リンク (distributed
program link) を参照。
E
EBCDIC. 拡張 2 進化 10 進コード (Extended
binary-coded decimal interchange code) を参照。
ECI. 外部呼び出しインターフェース (external
call interface) を参照。
用語集
251
用語集
EJB.
作成日付: 2005年12月2日
Enterprise JavaBeans を参照。
Enterprise JavaBeans. オブジェクト指向、分
散、およびエンタープライズ・レベルのアプリケ
ーションの開発と配置用に Sun Microsystems に
よって定義されたコンポーネント・アーキテクチ
ャー (J2EE)。
EPI. 外部表示インターフェース (external
presentation interface) を参照。
ESI. 外部セキュリティー・インターフェース
(external security interface) を参照。
EXCI. 外部 CICS インターフェース (External
CICS Interface) を参照。
H
HTTP.
照。
HTTP (Hypertext Transfer Protocol) を参
HTTP (Hypertext Transfer Protocol). インター
ネット・プロトコル群において、ハイパーテキス
トおよび XML 文書を転送し表示するのに使用さ
れるプロトコル。
HTTPS. 機密保護機能のある HTTP (Hypertext
Transfer Protocol Secure) を参照。
I
iKeyman. JSSE に関するデジタル証明書の保守
用として提供されるツール。
Internet Architecture Board. TCP/IP として知ら
れているインターネットのプロトコル群の開発を
監督する技術機関。
IP. インターネット・プロトコル。
IP アドレス (IP address). インターネット上
の、個々の装置やワークステーションのロケーシ
ョンを指定する 32 ビットの固有アドレス。例え
ば、9.67.97.103 などが IP アドレスである。
252
J
J2EE. Java 2 プラットフォーム Enterprise
Edition
J2EE Connector architecture (JCA). 異機種のエ
ンタープライズ情報システム (EIS) に J2EE プラ
ットフォームを接続する標準アーキテクチャー。
Java. リモート・オブジェクト間の対話をサポー
トする移植可能解釈コード用のオブジェクト指向
プログラム言語。
Java 2 プラットフォーム Enterprise Edition
(Java 2 Platform Enterprise Edition (J2EE)).
Sun Microsystems Inc. によって定義された、エン
タープライズ・アプリケーションを開発および配
置するための環境。J2EE プラットフォームは、
多層 Web ベース・アプリケーションの開発を可
能にする、一連のサービス、アプリケーション・
プログラミング・インターフェース (API)、およ
びプロトコルを集めたセットから成る。
Java Development Kit (JDK). Sun Microsystems
が Java プラットフォーム用に提供したソフトウ
ェア開発キットの名前。 v 1.1.x までを含む。時
々、間違って Java プラットフォームまたは Java
用のソフトウェア開発者用キットの総称として使
われることがある。
Java Native Interface (JNI). Java 仮想マシンで
実行中の Java コードで他のプログラム言語で書
かれている関数の処理を可能にするプログラミン
グ・インターフェース。
Java Secure Socket Extension (JSSE). 1 つの
Java パッケージで、これにより機密保護機能のあ
るインターネット通信ができる。Secure Sockets
Layer (SSL) および Transport Layer Security
(TLS) プロトコルの Java バージョンをインプリ
メントし、データ暗号化、サーバー認証、メッセ
ージ保全性、およびオプションとしてクライアン
ト認証をサポートする。
CICS Transaction Gateway: プログラミング・リファレンス
用語集
作成日付: 2005年12月2日
Java 仮想マシン (JVM) (Java virtual machine
(JVM)). コンパイル済み Java コード (アプレッ
トおよびアプリケーション) を実行するプロセッ
サーのソフトウェア・インプリメンテーション。
Java クライアント・アプリケーション (Java
Client application). (1) Java で書かれ、サーブレ
ットおよびエンタープライズ Bean を含む、ゲー
トウェイ・クラスを使用するユーザー・アプリ
ケーション。 (2)
Java ランタイム環境 (JRE) (Java Runtime
Environment (JRE)). Java Software Development
Kit (SDK) のサブセットで、Java アプリケーショ
ンの実行をサポートする。その開発はサポートし
ない。JRE は、Java 仮想マシン (JVM)、コア・
クラス、およびサポートするファイルで構成され
る。
JavaBeans. Sun Microsystems によって Java 用
に定義された、ポータブルでプラットフォームに
依存しない、再使用可能なコンポーネント・モデ
ル。
JavaGateway. CICS Transaction Gateway の
URL で、Java クライアント・アプリケーション
がその URL と通信する。JavaGateway の書式
は、protocol://address:port である。サポート
されるプロトコルは、 tcp://、ssl://、および
local: である。CICS Transaction Gateway は、
デフォルト・ポート値 2006 を使って稼働する。
このパラメーターは、プロトコル local: を使用
する場合には関係がない。たとえば、
tcp://ctg.business.com:2006 という
JavaGateway を指定することができる。プロトコ
ルを local: と指定すると、すべての CICS
Transaction Gateway サーバーを迂回して、CICS
サーバーに直接接続する。
JCA.
照。
J2EE Connector Architecture (JCA) を参
JDK.
Java development kit (JDK) を参照。
JNI.
JRE. Java ランタイム環境を参照。
JSSE.
照。
Java Secure Socket Extension (JSSE) を参
JVM. Java 仮想マシン (JVM) (Java Virtual
Machine (JVM)) を参照。
L
LUW.
照。
作業論理単位 (logical unit of work) を参
LU-LU セッション (LU-LU session). SNA にお
いて、SNA ネットワーク内の 2 つの論理装置
(LU) 間のセッション。これによって、2 つのエ
ンド・ユーザー間、または 1 つのエンド・ユー
ザーと 1 つの LU サービス・コンポーネント間
に通信が提供される。
LU-LU セッション・タイプ (LU-LU session type
6.2). SNA において、対等システム間の通信用セ
ッションのタイプの 1 つ。APPC プロトコル
(APPC protocol) と同義。
P
PING. インターネット通信において、宛先にイ
ンターネット制御メッセージ・プロトコル
(ICMP) エコーを送信し、応答を待機して宛先に
到達する能力をテストするために TCP/IP ネット
ワークで使用されるプログラム。
PLU. 1 次論理装置 (primary logical unit) およ
びパートナー論理装置 (partner logical unit) を
参照。
R
RACF. アクセス制御を提供する IBM ライセン
ス・プログラム。システムに対してユーザーを識
別し、システムのユーザーを検証し、保護リソー
スへのアクセスを許可し、システムに入ろうとし
Java Native Interface (JNI) を参照。
用語集
253
用語集
作成日付: 2005年12月2日
て検出された無許可の試みをログに記録し、保護
リソースへのアクセスを検出してログに記録す
る。
System Management Interface Tool (SMIT).
AIX オペレーティング・システムがインストー
ル、保守、構成、および診断タスクなどを行うイ
ンターフェース・ツール。
RPC. リモート・プロシージャー・コール
(remote procedure call) を参照。
T
RU. 要求単位 (Request unit)。応答単位
(Response unit)。
TCP/IP. 相互接続されたさまざまなタイプのネ
ットワークを使用して、アプリケーション相互の
エンドツーエンド接続を実現する業界標準でしか
も所有権の付いていない一連の通信プロトコル。
S
SBCS. 1 バイト文字セット (single-byte character
set) を参照。
Secure Sockets Layer (SSL). 通信のプライバシ
ーをもたらすセキュリティー・プロトコル。SSL
によって、クライアント/サーバー・アプリケーシ
ョンは、盗聴、改ざん、およびメッセージ偽造を
防止するように設計された方法で通信できる。
SSL は、インターネット・プロトコルにのみ適用
され、SNA には適用されない。
SIT. システム初期設定テーブル (system
initialization table) を参照。
SNA センス・データ (SNA sense data). エラー
情報の SNA 定義エンコード方式の 1 つ。 SNA
において、否定応答を伴って送信され、その応答
の理由を示すデータ。
SNASVCMG モード名 (SNASVCMG mode
name). SNA サービス・マネージャー・モード
名。CNOS の交換が行われるセッションを識別す
る、体系的に定義されたモード名。APPC を提供
する製品のほとんどは、SNASVCMG セッション
を事前定義している。
SSL.
Secure Sockets Layer (SSL) を参照。
SSLight. Java で作成された SSL のインプリメ
ンテーションで、CICS Transaction Gateway は、
すでにサポートを打ち切っている SSL。
254
TCP/IP. TCP/IP (Transmission Control
Protocol/Internet Protocol) を参照。
|
|
|
TCP/IP ロード・バランシング (load balancing).
ターゲット・サーバー全体に TCP/IP 接続を配布
する機能。
TPC62. SNA 論理装置タイプ 62 (LU62) プロト
コルは、TCP/IP にカプセル化される。これによ
り APPC アプリケーションは、アプリケーショ
ンを変更することなく、TCP/IP ネットワークを
使用して通信することが可能。
U
URL (Uniform Resource Locator). コンピュー
ター上の、またはインターネットなどのネットワ
ーク内の情報リソースを表す一連の文字。この一
連の文字には、(a) 情報リソースにアクセスする
場合に使用するプロトコルの省略名、および (b)
そのプロトコルが情報リソースを見つけるのに使
用する情報が含まれる。
V
verb. (1) アプリケーション・プログラミング・
インターフェース (API)、コンパイラー、または
オブジェクト・プログラムが起こすアクションを
表現する予約語。 (2) SNA において、トランザ
クション・プログラムによる通信サービス要求を
表す汎用名。
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
用語集
W
Web サーバー (Web server). Web ブラウザー
によって生成された情報要求に応答するソフトウ
ェア・プログラム。
Web ブラウザー (Web browser). Web サーバー
に要求を送信し、サーバーが戻す情報を表示する
ソフトウェア・プログラム。
X
|
|
|
XA トランザクション (XA transaction). 分散ト
ランザクション処理処理 (DTP) の X/Open 標準
に準拠したグローバル・トランザクション。
用語集
255
用語集
256
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
作成日付: 2005年12月2日
索引
日本語, 数字, 英字, 特殊文字の順に配列されてい
ます。なお, 濁音と半濁音は清音と同等に扱われ
ています。
［タ行］
端末索引 148, 152
データ変換 106, 113, 126, 129
デフォルトのインストール場所
x
［ア行］
アクセシビリティ
インストール
［ハ行］
237
デフォルトの場所
パス x
インストール・パス
プログラミング
参照 49
x
x
［マ行］
［カ行］
画面
Field COM クラス
記述
CICS_EciListSystems
マイグレーション
メソッド
17
133
ゲートウェイ初期設定ファイル
Connect 38
Details 6
ServerCount 13, 16
ServerDesc 16
ServerName 8, 16, 43
コード・ページ 106, 113, 126, 129
コールバック・ルーチン
ECI 111, 116, 121, 124
EPI 150, 154
［サ行］
システム情報構造 133, 147
資料 233
CICS Transaction Gateway 233
資料、CICS Transaction Gateway 233
身体障害 237
© Copyright IBM Corp. 1989, 2005
x
AbendCode 24
AlterSecurity 5, 37
AppendString 2
AppendText 18
BackgroundColor 18
BackOut 47
BaseAttribute 19
Buffer COM クラス 2
CallType 24
CallTypeText 24
Cancel 5
CCSId 37
Changed 5
ChangePassword 6, 37
Column 19
Commit 47
Connect 38
Connect COM クラス 5
CursorCol 29
CursorRow 29
Data 2
DataTag 19
Depth 29
Details 6
Devtype 38
Diagnose 14, 24, 35, 38
257
作成日付: 2005年12月2日
メソッド (続き)
メソッド (続き)
Disconnect 38
DisconnectWithPurge
DiscReason
39
39
ECI COM クラス
Send 42
ServerCount
ServerDesc
11
ServerName
13, 16
13, 16
8, 13, 16, 42
EPI COM クラス 14
ErrorFormat 11, 14
ServerStatus 8
ServerStatusText
ErrorOffset
Session COM クラス
11, 14
8
ErrorWindow 12, 15
ExCode 12, 15, 27, 39
ExCodeText 12, 16, 39
SetAID 30
SetATI 43
SetBaseAttribute
ExtractString 2
Field COM クラス
FieldByIndex 29
SetCursor 31
SetData 3
SetErrorFormat
13, 16
SetExtAttribute
22
FieldByName
18
27
35
22
FieldByPosition 29
FieldCount 30
Flow COM クラス 24
SetLength 3
SetString 4
SetSyncType 25, 35
Flowid 24
ForceReset 24, 47
ForegroundColor 19
SetTermDefns 43
SetText 22
SetTimeout 25
Highlight 20
InputProt 20
SignonCapability
Start 44
InputType 20
InsertString 2
State 17, 35, 45
Status 9
Install 40
Intensity 21
Length 3, 21
Link 7
MakeSecurityDefault 7, 40
Map COM クラス 27
MapName 30
MapSetName 30
NetName 40
Overlay 3
Password 8, 40
Poll 25, 41
PollForReply 41
Position 21
QueryATI 41
ReadTimeout 42
ReceiveATI 42
ResetDataTag 21
Row 21
Screen 42
Screen COM クラス 29
String 4
SyncType 26
TermId 45
Terminal COM クラス 37
Terminate 17
Text 22
TextLength 22
Timeout 26
TranDetails 9
TransId 36, 45
Transparency 23
UnpaddedPassword 9
UnpaddedServerName 10
UnpaddedUserid 10
UOW COM クラス 47
UowId 47
UserId 10
Userid 45
Validate 28
VerifyPassword 10, 46
Wait 26
258
CICS Transaction Gateway: プログラミング・リファレンス
44
作成日付: 2005年12月2日
メソッド (続き)
Width
列挙型 (続き)
CclScreen クラス 84
CclSession クラス 88
31
CclTerminal クラス
［ヤ行］
Color
ユーザー定義の戻りコード
DataAreaOwner 57
DataAreaType 57
CICS_EciDataReturnExit 191
CICS_EciDataSendExit 190
CICS_EciExternalCallExit1 186
EndTerminalReason
［ワ行］
CICS_EpiGetEventExit 205
CICS_EpiInitializeExit 195
CICS_EpiReplyExit 203
CICS_EpiStartTranExit
CICS_EpiTranFailedExit 208
ユーザー定義のもの
CICS_EpiSystemIdExit 207
CICS_EpiTerminateExit 196
用語集、用語および省略語 246
列挙型
AID 84
ATIState 97
BaseInts 74
BaseMDT 74
BaseProt 74
BaseType 74
Bool 51
CallType 79
Ccl クラス 51
CclBuf クラス
CclConn クラス
CclEPI クラス
CclField クラス
CclFlow クラス
57
63
68
74
79
ワークロード・マネージャー
202
CICS_EpiStartTranExtendedExit
CICS_EpiTermIdExit 199
CICS_EpiTermIdInfoExit 200
［ラ行］
State 68, 88, 97
Sync 51
Transparency 75
189
CICS_EciTerminateExit 185
CICS_EpiAddTerminalExit 197
CICS_EpiDelTerminalExit 204
98
Highlight 75
ServerStatus 63
signonType 97
CICS_EciExternalCallExit2 187
CICS_EciInitializeExit 184
CICS_EciSetProgramAliasExit 192
CICS_EciSystemIdExit
97
75
201
191
A
AbendCode
メソッド
Flow COM クラス
abendCode
24
CclException クラス 69
CclFlow クラス 76
public メソッド 69, 76
active
State 68
state 67
activeFlow
CclConn クラス 58
CclFlow クラス 76
CclUOW クラス 98
activeUOW
CclConn クラス 58
CclUOW クラス 98
AID
列挙型 84
CclScreen クラス 84
alphanumeric
BaseType 74
inputType 72
索引
259
作成日付: 2005年12月2日
B
AlterSecurity
メソッド
Connect COM クラス
5
BackgroundColor
メソッド
Field COM クラス
Terminal COM クラス 37
alterSecurity
CclConn クラス 59
CclTerminal クラス 91
public メソッド
59, 91
alterSecurity (パラメーター)
alterSecurity 59
AppendString
メソッド
Buffer COM クラス
AppendText
2
18
public メソッド 70
array (パラメーター)
SetData 3
assign
CclBuf クラス
public メソッド
async
53
53
CclSession コンストラクター 87
Sync 51
ATIState
列挙型 97
CclTerminal クラス 97
ATIState パラメーター
CICS_EpiATIState 関数 165
attachTran (パラメーター)
CclConn コンストラクター 58
TranDetails 9
Attribute (パラメーター)
SetBaseAttribute 22
SetExtAttribute 22
attribute (パラメーター)
setBaseAttribute 73
setExtAttribute 73
Attributes パラメーター
CICS_EpiAddExTerminal 関数 154
available
ServerStatus 63
260
CclField クラス
71
public メソッド
BackOut
71
メソッド
メソッド
Field COM クラス
appendText
CclField クラス 70
18
backgroundColor
UOW COM クラス
Backout
Poll 25
backout
CallType 79
CclUOW クラス
99
public メソッド
99
BaseAttribute
メソッド
Field COM クラス
baseAttribute
CclField クラス 71
public メソッド 71
BaseInts
列挙型
74
CclField クラス
BaseMDT
列挙型 74
CclField クラス
BaseProt
列挙型 74
CclField クラス
BaseType
列挙型 74
CclField クラス
black
Color 75
blinkHlt
Highlight 75
blue
Color 75
Bool
列挙型 51
Ccl クラス 51
Buffer
AppendString 2
CICS Transaction Gateway: プログラミング・リファレンス
74
74
74
74
47
19
作成日付: 2005年12月2日
Buffer (続き)
cancel (続き)
Buffer COM クラス
Link 7
Poll
String
1
CclConn クラス 59
public メソッド 59
Ccal Screen.fieldbyPosition メソッド
25
Field COM クラス
4
Buffer COM クラス
メソッド
1
AppendString
2
Sync
51
Data 2
ExtractString 2
InsertString 2
cclActive
State 17, 35
cclAlphanumeric
Length 3
Overlay 3
SetData 3
InputType 20
cclATIDisabled
QueryATI 41
SetLength
3
SetString 4
String 4
buffer (パラメーター)
CclBuf 53
operator!= 56
operator+= 55
operator= 55
operator== 56
C
CallType
メソッド
Flow COM クラス 24
列挙型 79
CclFlow クラス 79
callType
CclFlow クラス 76
public メソッド 76
CallTypeText
メソッド
Flow COM クラス 24
callTypeText
CclFlow クラス 77
public メソッド 77
Cancel
メソッド
Connect COM クラス 5
Poll 25
cancel
CallType 79
18
Ccl クラス
Bool 51
SetATI
43
cclATIEnabled
QueryATI 41
SetATI 43
cclAvailable
ServerStatus
CclBuf
8
CclBuf クラス 52, 53
CclBuf コンストラクター
52, 53
CclBuf クラス
assign 53
CclBuf 52, 53
cut 54
dataArea 54
dataAreaLength 54
DataAreaOwner 57
dataAreaOwner 54
DataAreaType 57
dataAreaType 54
dataLength 54
insert 55
listState 55
operator!= 56
operator+= 55, 56
operator= 55
operator== 56
replace 56
setDataLength 57
CclBuf コンストラクター
CclBuf 52, 53
CclBuf クラス 52
索引
261
作成日付: 2005年12月2日
CclEPI クラス (続き)
cclClient
State 35
CclConn クラス
alterSecurity
cancel
state 67
terminate 68
change password
changed 59
link
CclEPI コンストラクター
59
CclEPI クラス
59
59
cclError
State
17, 36
CclException クラス
60
listState 60
makeSecurityDefault
password 61
abendCode 69
className 69
diagnose 69
61
serverName 61
ServerStatus 63
serverStatus 62
serverStatusText
status 62
userId 62
verifyPassword
exCode 69
exCodeText 69
exObject 69
62
62
methodName
70
CclField クラス
appendText 70
backgroundColor
CclConn コンストラクター
CclConn クラス 58
cclDark
baseAttribute 71
BaseInts 74
BaseMDT 74
Intensity
cclDiscon
BaseProt 74
BaseType 74
21
State 17, 36
cclDSync
SetSyncType 25, 35
CclECI クラス
exCode 64
exCodeText 64
handleException 64
instance 64
listState 65
serverCount 65
serverDesc 65
serverName 65
CclECI コンストラクター (保護)
CclECI クラス 63
CclEPI クラス
diagnose 66
exCode 66
exCodeText 66
handleException 67
serverCount 67
serverDesc 67
serverName 67
State 68
262
66
71
Color 75
column 71
dataTag 71
foregroundColor 71
Highlight 75
highlight 71
inputProt 71
inputType 72
intensity 72
length 72
position 72
resetDataTag 72
row 73
setBaseAttribute 73
setExtAttribute 73
setText 73
text 74
textLength 74
Transparency 75
transparency 74
CclFlow
CclFlow クラス 76
CclFlow コンストラクター
CICS Transaction Gateway: プログラミング・リファレンス
76
作成日付: 2005年12月2日
CclScreen クラス (続き)
CclFlow クラス
abendCode 76
CallType 79
cursorRow
depth 82
callType
field
76
callTypeText
77
82
83
fieldCount
83
CclFlow 76
connection 77
mapName 83
mapSetName 83
diagnose
setAID
77
84
flowId 77
forceReset 77
handleReply 77
setCursor 84
width 84
CclSecAttr 84
listState 78
poll 78
setTimeout 78
cclServer
State 35
CclSession クラス
syncType
78
diagnose
timeout 79
uow 79
wait 79
87
handleReply
State 88
state 87
87
CclFlow コンストラクター
CclFlow 76
CclFlow クラス 76
terminal 88
transID 88
CclSession コンストラクター
cclIntense
Intensity
CclSession クラス
cclSync
21
87
CclMap クラス
exCode 80
SetSyncType
cclSystemError
exCodeText 80
field 81
namedField 81
validate 81
CclMap コンストラクター
CclMap クラス 80
cclModified
DataTag 19
cclNoError
ExCode 15
cclNormal
Intensity 21
cclNumeric
InputType 20
CclOSecTime
Ccl SecAttr インターフェース
cclProtect
InputProt 20
CclScreen クラス
AID 84
cursorCol 82
ExCode 15
CclTerminal クラス
alterSecurity 91
ATIState 97
CCSid 91
changePassword 91
diagnose 91
disconnect 91, 92
discReason 92
EndTerminalReason 98
exCode 92
exCodeText 92
install 93
makeSecurityDefault 93
netName 93
password 93
poll 93
queryATI 94
readTimeout 94
receiveATI 94
screen 95
32
25, 35
索引
263
作成日付: 2005年12月2日
CclTerminal クラス (続き)
send 95
serverName
setATI
CclConn クラス 59
public メソッド 59
96
95
Changed
signonCapability
signonType
State 97
state
change password
メソッド
96
Connect COM クラス
Cancel 5
97
96
Changed
termID 96
transID 96
userId 96
6
Details 7
Poll 25
changed
verifyPassword 97
CclTerminal コンストラクター
CclTerminal クラス 89
CallType 79
CclConn クラス 59
public メソッド 59
cclUnavailable
ServerStatus
ServerStatus
cclUnknown
ServerStatus
8
cclUnprotect
InputProt
8
8
Connect COM クラス 6
Terminal COM クラス 37
changePassword
CclTerminal クラス 91
public メソッド 91
21
CICS Transaction Gateway 初期設定ファイル
CclTerminal コンストラクター 89
20
CclUOW クラス
backout 99
commit 99
forceReset 99
listState 99
uowId 99
CclUOW コンストラクター
CclUOW クラス 99
Ccl.Field
FieldByName 28
Ccl.Screen
Send 42
CCSId
メソッド
Terminal COM クラス 37
CCSid
CclTerminal クラス 91
public メソッド 91
CCSid (パラメーター)
CclTerminal コンストラクター
SetTermDefns 43
264
8
ServerStatusText
ChangePassword
メソッド
cclUnknownServer
ExCode 15
cclUnmodified
DataTag 19
ResetDataTag
5
90
serverCount 65, 67
serverDesc 67
serverName 67
CicsClientStatus 133
CicsServerStatus 132
CICS_ChangePassword 関数
定義 175
CICS_EciDataReturnExit 190
CICS_EciDataSendExit 189
CICS_EciExternalCallExit1 185
CICS_EciExternalCallExit2 187
CICS_EciInitializeExit 183
CICS_EciListSystems 関数 133
ECI_ERR_INVALID_DATA _LENGTH
ECI_ERR_MORE_SYSTEMS 134
ECI_ERR_NO_CICS 134
ECI_ERR_NO_SYSTEMS 134
ECI_ERR_SYSTEM_ERROR 134
ECI_NO_ERROR 134
CICS_EciSetProgramAliasExit 191
CICS_EciSystemIdExit 188
CICS Transaction Gateway: プログラミング・リファレンス
134
作成日付: 2005年12月2日
CICS_EciSystem_t データ構造
定義
用途
CICS_EciTerminateExit
202
CICS_EpiSetSecurity 関数
定義 159
CICS_EpiStartTran 関数
184
CICS_ECI_DESCRIPTION_MAX
CICS_ECI_SYSTEM_MAX 133
CICS_EpiAddExTerminal 関数
定義
CICS_EpiReplyExit
133
134
152
133
定義
160
用途 162, 169
CICS_EpiStartTranExit
201
CICS_EpiStartTranExtendedExit
用途 135, 136, 137
CICS_EpiAddTerminal 関数
定義 148
CICS_EpiSystemIdExit 205
CICS_EpiSystem_t データ構造
定義 135
用途 135, 137, 160, 164
CICS_EpiAddTerminalExit 196
CICS_EpiATIState 関数
用途 147
CICS_EpiTermIdExit 198
CICS_EpiTermIdInfoExit 199
定義
CICS_EpiTerminate 関数
164
CICS_EpiAttributes_t データ構造
定義 136
CICS_EpiDelTerminal 関数
定義 157
用途 146, 157, 170
CICS_EpiDelTerminalExit
200
203
定義 146
CICS_EpiTerminateExit 195
CICS_EpiTranFailedExit 207
CICS_EPI_ADD_TERM イベント
定義 167
CICS_EPI_ATI_HOLD
164, 165
CICS_EpiDetails_t データ構造
定義 137
CICS_EPI_ATI_ON 164, 165
CICS_EPI_ATI_QUERY 165
用途 148, 150, 152, 154
CICS_EpiEventData_t データ構造
CICS_EPI_DESCRIPTION_MAX 136
CICS_EPI_DEVTYPE_MAX 150, 153
CICS_EPI_END_FAILED 170
定義 139
用途 166
CICS_EpiGetEvent 関数
定義 165
用途 139, 140, 157, 162
CICS_EpiGetEventExit 204
CICS_EpiInitialize 関数
定義 145
用途 146, 147
CICS_EpiInitializeExit 194
CICS_EpiInquireSystem 関数
定義 156
CICS_EpiListSystems 関数
定義 147
用途 135
CICS_EpiPurgeTerminal 関数
定義 158
ATI 要求の取り消し 158
CICS_EpiReply 関数
定義 163
用途 168
CICS_EPI_END_OUTSERVICE 170
CICS_EPI_END_SHUTDOWN 170
CICS_EPI_END_SIGNOFF 170
CICS_EPI_END_UNKNOWN 170
CICS_EPI_ERR_ABENDED 戻りコード
CICS_EpiReply 関数 164
CICS_EPI_ERR_ADDTYPE_INVALID 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EPI_ERR_ALREADY_INSTALLED 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiAddTerminal 関数 151
CICS_EPI_ERR_ATI_ACTIVE 戻りコード
CICS_EpiStartTran 関数 162
CICS_EPI_ERR_ATI_STATE 戻りコード
CICS_EpiATIState 関数 165
CICS_EPI_ERR_BAD_INDEX 戻りコード
CICS_EpiATIState 関数 165
CICS_EpiDelTerminal 関数 157
CICS_EpiGetEvent 関数 166
CICS_EpiInquireSystem 関数 156
索引
265
作成日付: 2005年12月2日
CICS_EPI_ERR_BAD_INDEX 戻りコード (続き)
CICS_EpiPurgeTerminal 関数 158
CICS_EpiReply 関数 164
CICS_EpiSetSecurity 関数
CICS_EpiStartTran 関数
160
162
CICS_EPI_ERR_CCSID_INVALID 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EPI_ERR_MORE_DATA 戻りコード
CICS_EpiGetEvent 関数
CICS_EpiGetEvent 関数 167
CICS_EPI_ERR_MORE_SYSTEMS 戻りコード
CICS_EpiListSystems 関数 148
CICS_EPI_ERR_NOT_3270_DEVICE 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiAddTerminal 関数 151
CICS_EPI_ERR_FAILED 戻りコード
CICS_EpiAddExTerminal 関数 154
CICS_EpiAddTerminal 関数 151
CICS_EpiATIState 関数 165
CICS_EpiDelTerminal 関数 157
CICS_EpiGetEvent 関数 166
CICS_EpiInitialize 関数 146
CICS_EPI_ERR_NOT_INIT 戻りコード
CICS_EpiAddExTerminal 関数 154
CICS_EpiAddTerminal 関数 151
CICS_EpiATIState 関数 165
CICS_EpiDelTerminal 関数 157
CICS_EpiGetEvent 関数 167
CICS_EpiInquireSystem 関数 157
CICS_EpiInquireSystem 関数 156
CICS_EpiListSystems 関数 147
CICS_EpiPurgeTerminal 関数 158
CICS_EpiReply 関数 164
CICS_EpiListSystems 関数 148
CICS_EpiPurgeTerminal 関数 158
CICS_EpiReply 関数 164
CICS_EpiStartTran 関数 162
CICS_EpiTerminate 関数 146
CICS_EPI_ERR_IN_CALLBACK 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiAddTerminal 関数 151
CICS_EpiATIState 関数 165
CICS_EpiDelTerminal 関数 158
CICS_EpiGetEvent 関数 167
CICS_EpiInquireSystem 関数 157
CICS_EpiListSystems 関数 148
CICS_EpiPurgeTerminal 関数 158
CICS_EpiReply 関数 164
CICS_EpiSetSecurity 関数 160
CICS_EpiStartTran 関数 162
CICS_EpiTerminate 関数 146
CICS_EPI_ERR_IS_INIT 戻りコード
CICS_EpiInitialize 関数 146
CICS_EPI_ERR_MAX_SESSIONS 戻りコード
CICS_EpiAddExTerminal 関数 156
CICS_EpiAddTerminal 関数 151
CICS_EpiStartTran 関数 163
CICS_EPI_ERR_MAX_SYSTEMS 戻りコード
CICS_EpiAddExTerminal 関数 156
CICS_EpiAddTerminal 関数 151
CICS_EPI_ERR_MODEL_INVALID 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiAddTerminal 関数 151
266
166
CICS_EPI_ERR_MORE_EVENTS 戻りコード
CICS_EpiSetSecurity 関数 160
CICS_EpiStartTran 関数 162
CICS_EpiTerminate 関数 146
CICS_EPI_ERR_NO_CONVERSE 戻りコード
CICS_EpiReply 関数 164
CICS_EPI_ERR_NO_DATA 戻りコード
CICS_EpiReply 関数 164
CICS_EpiStartTran 関数 162
CICS_EPI_ERR_NO_EVENT 戻りコード
CICS_EpiGetEvent 関数 167
CICS_EPI_ERR_NO_SYSTEMS 戻りコード
CICS_EpiListSystems 関数 148
CICS_EPI_ERR_NULL_PARM 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiAddTerminal 関数 151
CICS_EpiGetEvent 関数 167
CICS_EpiInquireSystem 関数 157
CICS_EpiListSystems 関数 148
CICS_EPI_ERR_NULL_PASSWORD 戻りコード
CICS_EpiSetSecurity 関数 160
CICS_EPI_ERR_NULL_USERID 戻りコード
CICS_EpiSetSecurity 関数 160
CICS_EPI_ERR_PASSWORD_INVALID 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiSetSecurity 関数 160
CICS_EPI_ERR_RESOURCE_SHORTAGE 戻りコード
CICS_EpiAddExTerminal 関数 156
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
CICS_EPI_ERR_RESOURCE_SHORTAGE 戻りコード
(続き)
CICS_EpiAddTerminal 関数 151
CICS_EpiStartTran 関数 163
CICS_EPI_ERR_RESPONSE_TIMEOUT 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EPI_ERR_SECURITY 戻りコード
CICS_EpiAddExTerminal 関数 154
CICS_EpiAddTerminal 関数 151
CICS_EPI_ERR_SERVER_BUSY 戻りコード
CICS_EpiAddExTerminal 関数 156
CICS_EpiAddTerminal 関数 151
CICS_EPI_ERR_SERVER_DOWN 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiAddTerminal 関数 151
CICS_EpiReply 関数
164
CICS_EpiStartTran 関数 162
CICS_EPI_ERR_SIGNONCAP_INVALID 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EPI_ERR_SIGNON_NOT_POSS 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EPI_ERR_SYSTEM 戻りコード
CICS_EpiAddExTerminal 関数 154
CICS_EpiAddTerminal 関数 151
CICS_EPI_ERR_SYSTEM_ERROR 戻りコード
CICS_EpiSetSecurity 関数 160
CICS_EPI_ERR_TERMID_INVALID 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiAddTerminal 関数 151
CICS_EPI_ERR_TRAN_ACTIVE 戻りコード
CICS_EpiDelTerminal 関数 158
CICS_EPI_ERR_TTI_ACTIVE 戻りコード
CICS_EpiStartTran 関数 162
CICS_EpiTerminate 関数 146
CICS_EPI_ERR_USERID_INVALID 戻りコード
CICS_EpiAddExTerminal 関数 155
CICS_EpiSetSecurity 関数 160
CICS_EPI_ERR_VERSION 戻りコード
CICS_EpiAddExTerminal 関数 156
CICS_EpiInitialize 関数 146
CICS_EpiPurgeTerminal 関数 159
CICS_EpiSetSecurity 関数 160
CICS_EPI_ERR_WAIT 戻りコード
CICS_EpiGetEvent 関数 167
CICS_EPI_EVENT_CONVERSE イベント
定義 168
CICS_EPI_EVENT_CONVERSE イベント (続き)
用途 163, 168
CICS_EPI_EVENT_END_TERM イベント
定義
170
用途
139, 157, 158
CICS_EPI_EVENT_END_TRAN イベント
定義 168
用途
139, 160, 161
CICS_EPI_EVENT_SEND イベント
定義 168
CICS_EPI_EVENT_START_ATI イベント
定義 169
用途 162
CICS_EPI_NETNAME_MAX
137, 149, 152
CICS_EPI_NORMAL 戻りコード
CICS_EpiAddExTerminal 関数 156
CICS_EpiAddTerminal 関数 152
CICS_EpiATIState 関数 165
CICS_EpiDelTerminal 関数 158
CICS_EpiGetEvent 関数 167
CICS_EpiInitialize 関数 146
CICS_EpiInquireSystem 関数 157
CICS_EpiListSystems 関数 148
CICS_EpiPurgeTerminal 関数
CICS_EpiReply 関数 164
159
CICS_EpiSetSecurity 関数 160
CICS_EpiStartTran 関数 163
CICS_EpiTerminate 関数 147
CICS_EPI_NOWAIT 166
CICS_EPI_NULL_PARAM 戻りコード
CICS_EpiATIState 関数 165
CICS_EPI_READTIMEOUT_EXPIRED 169
CICS_EPI_SYSTEM_MAX 135, 149, 152
CICS_EPI_TERM_INDEX_NONE 166
CICS_EPI_TRANSID_MAX 139, 161
CICS_EPI_TRAN_NOT_STARTED 169
CICS_EPI_TRAN_NO_ERROR 169
CICS_EPI_TRAN_STATE_UNKNOWN 169
CICS_EPI_VERSION_200 146
CICS_EPI_WAIT 166
CICS_EsiDate_t データ構造
定義 171
CICS_EsiDetails_t データ構造
定義 172
CICS_EsiTime_t データ構造
定義 171
索引
267
作成日付: 2005年12月2日
CICS_ESI_ERR_CALL_FROM_CALLBACK 戻りコード
CICS_ESI_ERR_SECURITY_ERROR 戻りコード
CICS_ChangePassword 関数
CICS_ChangePassword 関数 176
CICS_SetDefaultSecurity 関数 179
CICS_VerifyPassword 関数 174
CICS_VerifyPassword 関数
CICS_ESI_ERR_SYSTEM_ERROR 戻りコード
CICS_ChangePassword 関数 176
CICS_SetDefaultSecurity 関数 179
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_CICS_DIED 戻りコード
CICS_ChangePassword 関数 177
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_MAX_SESSIONS 戻りコード
CICS_ChangePassword 関数 177
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_MAX_SYSTEMS 戻りコード
CICS_ChangePassword 関数 177
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_NO_CICS 戻りコード
CICS_ChangePassword 関数 176
CICS_SetDefaultSecurity 関数 179
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_NO_SESSIONS 戻りコード
CICS_ChangePassword 関数 177
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_NULL_NEW_PASSWORD 戻りコード
CICS_ESI_ERR_UNKNOWN_SERVER 戻りコード
CICS_ChangePassword 関数 177
CICS_SetDefaultSecurity 関数 179
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_USERID_INVALID 戻りコード
CICS_ChangePassword 関数 178
CICS_SetDefaultSecurity 関数 180
CICS_VerifyPassword 関数 175
CICS_ESI_NO_ERROR 戻りコード
CICS_ChangePassword 関数 176
CICS_SetDefaultSecurity 関数 179
CICS_VerifyPassword 関数 173
CICS_EXIT_BAD_ANCHOR 戻りコード
CICS_EciDataReturnExit 191
CICS_EciDataSendExit 190
CICS_EciExternalCallExit1 186
CICS_ChangePassword 関数 177
CICS_ESI_ERR_NULL_OLD_PASSWORD 戻りコード
CICS_ChangePassword 関数 177
CICS_ESI_ERR_NULL_PASSWORD 戻りコード
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_NULL_USERID 戻りコード
CICS_ChangePassword 関数 177
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_PASSWORD_EXPIRED 戻りコード
CICS_VerifyPassword 関数 175
CICS_ESI_ERR_PASSWORD_INVALID 戻りコード
CICS_ChangePassword 関数 177
CICS_SetDefaultSecurity 関数 180
CICS_VerifyPassword 関数 175
CICS_ESI_ERR_PASSWORD_REJECTED 戻りコード
CICS_ChangePassword 関数 177
CICS_ESI_ERR_PEM_NOT_ACTIVE 戻りコード
CICS_ChangePassword 関数 177
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_PEM_NOT_SUPPORTED 戻りコード
CICS_ChangePassword 関数 177
CICS_VerifyPassword 関数 174
CICS_ESI_ERR_RESOURCE_SHORTAGE 戻りコード
CICS_ChangePassword 関数 177
CICS_VerifyPassword 関数 174
268
178
175
CICS_EciExternalCallExit2 187
CICS_EciSetProgramAliasExit 192
CICS_EciSystemIdExit 189
CICS_EciTerminateExit 184
CICS_EpiAddTerminalExit 197
CICS_EpiDelTerminalExit 204
CICS_EpiGetEventExit 205
CICS_EpiReplyExit 203
CICS_EpiStartTranExit 202
CICS_EpiStartTranExtendedExit 201
CICS_EpiSystemIdExit 207
CICS_EpiTermIdExit 199
CICS_EpiTermIdInfoExit 200
CICS_EpiTerminateExit 195
CICS_EpiTranFailedExit 208
CICS_EXIT_BAD_PARM 戻りコード
CICS_EciDataReturnExit 191
CICS_EciDataSendExit 190
CICS_EciExternalCallExit1 186
CICS_EciExternalCallExit2 187
CICS_EciSetProgramAliasExit 192
CICS_EciSystemIdExit 189
CICS_EpiAddTerminalExit 197
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
CICS_EXIT_BAD_PARM 戻りコード (続き)
CICS_EpiReplyExit
CICS_SetDefaultSecurity 関数
定義 178
CICS_VerifyPassword 関数
CICS_EpiDelTerminalExit 204
CICS_EpiGetEventExit 205
定義
203
CICS_EpiStartTranExit
202
CICS_EpiStartTranExtendedExit
CICS_EpiSystemIdExit 207
CICS_EpiTermIdExit
172
className
CclException クラス 69
public メソッド 69
201
199
clear
CICS_EpiTermIdInfoExit 200
CICS_EpiTranFailedExit 208
CICS_EXIT_BAD_STORAGE 戻りコード
AID 84
client
send 95
CICS_EciTerminateExit 185
CICS_EpiTerminateExit 195
CICS_EXIT_CANT_INIT_EXITS 戻りコード
col
CICS_EciInitializeExit
184
State
88, 97
validate
81, 82
col (パラメーター)
CICS_EpiInitializeExit 195
CICS_EXIT_DONT_ADD_TERMINAL 戻りコード
CICS_EpiAddTerminalExit 197
setCursor 84
Color
列挙型 75
CICS_EpiSystemIdExit 207
CICS_EXIT_GIVE_UP 戻りコード
CICS_EciSystemIdExit 189
CclField クラス 75
colPos (パラメーター)
FieldByPosition 29, 30
CICS_EXIT_NO_EXIT 戻りコード
CICS_EciInitializeExit 184
SetCursor
Column
CICS_EpiInitializeExit 195
CICS_EXIT_OK 戻りコード
CICS_EciDataReturnExit 191
CICS_EciDataSendExit 190
CICS_EciExternalCallExit1 185
CICS_EciExternalCallExit2 187
CICS_EciInitializeExit 184
CICS_EciSetProgramAliasExit 192
CICS_EciSystemIdExit 189
CICS_EciTerminateExit 184
CICS_EpiAddTerminalExit 197
CICS_EpiDelTerminalExit 204
CICS_EpiGetEventExit 205
CICS_EpiInitializeExit 194
CICS_EpiReplyExit 203
CICS_EpiStartTranExit 202
CICS_EpiStartTranExtendedExit 201
CICS_EpiSystemIdExit 207
CICS_EpiTermIdExit 199
CICS_EpiTermIdInfoExit 200
CICS_EpiTerminateExit 195
CICS_EpiTranFailedExit 208
CICS_ExternalCall 133
31
メソッド
Field COM クラス
column
CclField クラス 71
public メソッド 71
column (パラメーター)
field 81, 83
commArea (パラメーター)
AbendCode 24
Link 7
Poll 25
commarea (パラメーター)
handleReply 77
link 60
poll 78
Commit
メソッド
UOW COM クラス
Poll 25
commit
CallType 79
CclUOW クラス 99
public メソッド 99
19
47
索引
269
作成日付: 2005年12月2日
Connect
cut
メソッド
Terminal COM クラス
Connect COM クラス
ServerName
4
Color
10
Connect COM クラス 5
メソッド
AlterSecurity 5
Cancel 5
Changed 5
ChangePassword
Details
Status 9
TranDetails
D
intensity
darkBlue
Color
Data
6
ServerName 8
ServerStatus 8
ServerStatusText
75
dark
BaseInts
6
Link 7
MakeSecurityDefault
Password 8
7
9
UnpaddedUserid 10
UserId 10
VerifyPassword 10
connection
CclFlow クラス 77
public メソッド 77
ConnectionType 132
CreateObject 1, 5, 11, 14, 23, 27, 34, 36, 46
CursorCol
メソッド
Screen COM クラス 29
cursorCol
CclScreen クラス 82
public メソッド 82
CursorRow
メソッド
Screen COM クラス 29
cursorRow
CclScreen クラス 82
public メソッド 82
74
72
75
メソッド
Buffer COM クラス
Data パラメーター
2
CICS_EpiReply 関数 163
CICS_EpiStartTran 関数 161
dataArea
8
UnpaddedPassword 9
UnpaddedServerName 10
270
cyan
8
Terminal COM クラス 36
UOW COM クラス 46
UserId
CclBuf クラス 54
public メソッド 54
38
CclBuf クラス
54
public メソッド 54
dataArea (パラメーター)
assign 53
CclBuf 53
insert 55
replace 56
dataAreaLength
CclBuf クラス
public メソッド
DataAreaOwner
列挙型 57
CclBuf クラス
dataAreaOwner
CclBuf クラス
public メソッド
DataAreaType
列挙型 57
CclBuf クラス
dataAreaType
CclBuf クラス
public メソッド
dataLength
CclBuf クラス
link 60
public メソッド
CICS Transaction Gateway: プログラミング・リファレンス
54
54
57
54
54
57
54
54
54
54
作成日付: 2005年12月2日
dataStream
Diagnose
CclScreen クラス
DataTag
メソッド
EPI COM クラス
82
メソッド
Field COM クラス
dataTag
CclField クラス
71
public メソッド
71
19
Day
SecTime COM クラス 33
defaultColor
Color 75
defaultHlt
Highlight 75
Terminal COM クラス
EPI COM クラス 13
State 17, 36
diagnose
CclEPI クラス
Screen COM クラス 29
depth
CclScreen クラス
public メソッド
validate 81
82
82
Details
メソッド
Connect COM クラス 6
Connect COM クラス 4
Details パラメーター
CICS_ChangePassword 関数 176
CICS_EpiAddExTerminal 関数 154
CICS_EpiAddTerminal 関数 150
CICS_VerifyPassword 関数 173
Devtype
メソッド
Terminal COM クラス 38
DevType パラメーター
CICS_EpiAddExTerminal 関数 153
CICS_EpiAddTerminal 関数 150
devType (パラメーター)
Connect 38
SetTermDefns 43
devtype (パラメーター)
CclTerminal コンストラクター 89, 90
DFHCNV マクロ 106, 113, 126, 129
35
38
66
CclException クラス 69
CclFlow クラス 77
CclSession クラス 87
public メソッド
disabled
ATIState 97
75
24
Session COM クラス
CclTerminal クラス
defaultTran
Transparency
Depth
メソッド
14
Flow COM クラス
91
66, 69, 77, 87, 91
queryATI 94
setATI 95
discon
State
68, 88, 97
state 68
Disconnect
メソッド
Terminal COM クラス 38
Disconnect 38
disconnect
CclTerminal クラス 91, 92
public メソッド 91, 92
DisconnectWithPurge
メソッド
Terminal COM クラス 39
DiscReason
メソッド
Terminal COM クラス 39
DiscReason 39
discReason
CclTerminal クラス 92
public メソッド 92
display (パラメーター)
ErrorWindow 12, 15
dsync
CclSession コンストラクター 87
Sync 51
索引
271
作成日付: 2005年12月2日
eci_commarea (続き)
E
ECI COM クラス
11
メソッド
ErrorFormat
11
ErrorOffset
ErrorWindow
ECI_STATE_SYNC 呼び出しタイプ
ECI_SYNC 呼び出しタイプ 106
eci_commarea_length
ECI パラメーター・ブロックのフィールド
11
12
ECI_GET_SPECIFIC_REPLY 呼び出しタイプ
13
ECI_COMMIT 104, 107, 112, 114
ECI_CONNECTED_NOWHERE 132
ECI_CONNECTED_TO_CLIENT 132
ECI_CONNECTED_TO_SEVER
101
eci_abend_code
ECI パラメーター・ブロックのフィールド
ECI_SYNC 呼び出しタイプ 105
ECI_ASYNC 呼び出しタイプ
101
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 116
132
ECI_ERR_ALREADY_ACTIVE 110, 117
ECI_ERR_CALL_FROM _CALLBACK 103, 134
ECI_ERR_CICS_DIED 109, 127, 130
ECI_ERR_INVALID_CALL_TYPE 103
ECI_ERR_INVALID_DATA _LENGTH 109, 117, 120,
124, 126, 130, 134
定義 110
ECI_BACKOUT 104, 107, 112, 114
eci_callback 111, 121
ECI_ERR_INVALID_DATA_AREA
127, 131
102
ECI_STATE_ASYNC 呼び出しタイプ 124
eci_call_type 101
ECI パラメーター・ブロックのフィールド 101
ECI_ASYNC 呼び出しタイプ 111
ECI_GET_REPLY 呼び出しタイプ 125
ECI_GET_REPLY_WAIT 呼び出しタイプ 128
ECI_GET_SPECIFIC_REPLY 呼び出しタイプ 129
ECI_GET_SPECIFIC_REPLY_WAIT 呼び出しタイプ
132
ECI_STATE_ASYNC 呼び出しタイプ 121
ECI_STATE_SYNC 呼び出しタイプ 118
ECI_SYNC 呼び出しタイプ 104
ECI_CLIENTSTATE_INAPPLICABLE 133
ECI_CLIENTSTATE_UNKNOWN 133
ECI_CLIENTSTATE_UP 133
eci_commarea
ECI パラメーター・ブロックのフィールド 101
ECI_ASYNC 呼び出しタイプ 113
ECI_GET_REPLY 呼び出しタイプ 125
ECI_GET_SPECIFIC_REPLY 呼び出しタイプ 129
ECI_STATE_ASYNC 呼び出しタイプ 121
272
129
ECI_STATE_ASYNC 呼び出しタイプ 122
ECI_STATE_SYNC 呼び出しタイプ 118
ECI_SYNC 呼び出しタイプ 106
ServerDesc 13
ServerName 13
SetErrorFormat 13
ECI 状況ブロック 132
ECI 出口 181
ECI パラメーター・ブロック
102
ECI_ASYNC 呼び出しタイプ 113
ECI_GET_REPLY 呼び出しタイプ 126
ExCode 12
ExCodeText 12
ServerCount
118
110, 117, 120, 124,
ECI_ERR_INVALID_EXTEND _MODE
124
109, 117, 120,
ECI_ERR_INVALID_VERSION 103
ECI_ERR_LUW_TOKEN 110, 117, 120, 124
ECI_ERR_MAX_SESSIONS 110, 127, 131
ECI_ERR_MAX_SYSTEMS 110, 128, 131
ECI_ERR_MORE_SYSTEMS 134
ECI_ERR_NO_CICS 109, 117, 127, 130, 134
ECI_ERR_NO_REPLY 127, 130
ECI_ERR_NO_SESSIONS 110, 117
ECI_ERR_NO_SYSTEMS 134
ECI_ERR_REQUEST_TIMEOUT 103
ECI_ERR_RESOURCE_SHORTAGE 110, 117, 127, 131
ECI_ERR_RESPONSE_TIMEOUT 103
ECI_ERR_ROLLEDBACK 110, 127, 131
ECI_ERR_SECURITY_ERROR 110, 128, 131
ECI_ERR_SYSTEM_ERROR 103, 134
ECI_ERR_THREAD_CREATE_ERROR 117, 127, 131
ECI_ERR_TRANSACTION_ABEND 109, 127, 130
ECI_ERR_UNKNOWN_SERVER 110, 120, 127, 131
ECI_EXTENDED 107, 114
eci_extend_mode 104, 105, 109, 112, 113, 116, 118,
119, 121, 122, 123, 125, 129
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
eci_extend_mode (続き)
ECI_STATE_CANCEL
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 114
ECI_STATE_ASYNC 呼び出しタイプ
ECI_STATE_SYNC 呼び出しタイプ
102
122
ECI_STATUS 132
ECI_SYNC 呼び出しタイプ
定義 104
124
ECI_GET_REPLY_WAIT 呼び出しタイプ
定義 128
ECI_GET_SPECIFIC_REPLY 呼び出しタイプ
定義 128
ECI_GET_SPECIFIC_REPLY_WAIT 呼び出しタイプ
定義 131
eci_luw_token
ECI_STATE_SYNC 呼び出しタイプ
ECI_SYNC 呼び出しタイプ 107
eci_message_qualifier
102
ECI_GET_SPECIFIC_REPLY 呼び出しタイプ
129
eci_sysid
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 115
ECI_GET_REPLY 呼び出しタイプ
ECI_ASYNC 呼び出しタイプ
102
128,
ECI_STATE_ASYNC 呼び出しタイプ 121, 123
ECI_NO_ERROR 109, 117, 120, 124, 126, 130, 134
ECI_NO_EXTEND 106, 114
eci_password 104, 108, 112, 116
ECI パラメーター・ブロックのフィールド 101
ECI_ASYNC 呼び出しタイプ 112
ECI_SYNC 呼び出しタイプ 105
eci_password2 104, 105, 112
ECI パラメーター・ブロックのフィールド 103
ECI_ASYNC 呼び出しタイプ 116
ECI_SYNC 呼び出しタイプ 108
eci_program_name
ECI パラメーター・ブロックのフィールド 101
ECI_ASYNC 呼び出しタイプ 111
ECI_SYNC 呼び出しタイプ 104
ECI_SERVERSTATE_DOWN 133
ECI_SERVERSTATE_UNKNOWN 132
ECI_SERVERSTATE_UP 132
ECI_STATE_ASYNC 呼び出しタイプ
定義 120
102
126
ECI_GET_SPECIFIC_REPLY 呼び出しタイプ
ECI_STATE_ASYNC 呼び出しタイプ 123
ECI_STATE_SYNC 呼び出しタイプ 119
ECI_SYNC 呼び出しタイプ 108
eci_system_name
ECI パラメーター・ブロックのフィールド
119
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 111, 115
119, 122
ECI_STATE_SYNC 呼び出しタイプ
定義 117
118
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 115
ECI_STATE_ASYNC 呼び出しタイプ 123
119, 122, 123
ECI_STATE_IMMEDIATE
ECI_SYNC 呼び出しタイプ 106
ECI_GET_REPLY 呼び出しタイプ
定義
118, 119, 121, 122, 123, 125,
129
ECI_STATE_CHANGED
129
102
115
ECI_STATE_ASYNC 呼び出しタイプ 124
ECI_STATE_SYNC 呼び出しタイプ 120
ECI_SYNC 呼び出しタイプ 108
eci_timeout
ECI パラメーター・ブロックのフィールド
ECI_SYNC 呼び出しタイプ 106, 113
eci_tpn
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 116
ECI_SYNC 呼び出しタイプ 109
eci_transid
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 112
ECI_SYNC 呼び出しタイプ 105
eci_userid 105, 108, 112, 116
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 112
ECI_SYNC 呼び出しタイプ 104
eci_userid2 104, 105, 112
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 116
ECI_SYNC 呼び出しタイプ 108
eci_version
ECI パラメーター・ブロックのフィールド
ECI_ASYNC 呼び出しタイプ 115
ECI_GET_REPLY 呼び出しタイプ 126
102
103
101
101
102
102
索引
273
作成日付: 2005年12月2日
eci_version (続き)
ErrorWindow
ECI_GET_SPECIFIC_REPLY 呼び出しタイプ
ECI_STATE_ASYNC 呼び出しタイプ 123
ECI_STATE_SYNC 呼び出しタイプ
ECI_SYNC 呼び出しタイプ
108
130
120
メソッド
ECI COM クラス
12
EPI COM クラス
15
ESI
enabled
ATIState
97
関数 172
データ構造
queryATI
94
定数
Event パラメーター
CICS_EpiGetEvent 関数
except (パラメーター)
setATI 95
EndTerminalReason
列挙型 98
CclTerminal クラス
enter
AID 84
171
171
98
handleException
ExCode 12, 15
メソッド
64, 67
ECI COM クラス
EPI
イベント 167
関数 140
データ構造 135
State
exCode
274
17, 36
CclECI クラス 64
CclEPI クラス 66
CclException クラス
14
ErrorFormat 14
ErrorOffset 14
ErrorWindow 15
ExCode 15
ExCodeText 16
ServerCount 16
ServerDesc 16
ServerName 16
SetErrorFormat 16
State 17
Terminate 17
EPI 出口 192
error
State 68, 88, 97
state 68
ErrorFormat
メソッド
ECI COM クラス
EPI COM クラス
ErrorOffset
メソッド
ECI COM クラス
EPI COM クラス
12
EPI COM クラス 15
Map COM クラス 27
Terminal COM クラス 39
EPI COM クラス 13
ErrorWindow 12, 15
定数 134
EPI COM クラス 13
EPI COM クラス 14
メソッド
Diagnose
166
CclMap クラス
CclTerminal クラス
11
14
11
14
69
80
92
public メソッド 64, 66, 69, 80, 92
ExCodeText
メソッド
ECI COM クラス 12
EPI COM クラス 16
Terminal COM クラス 39
ExCode 12
exCodeText
CclECI クラス 64
CclEPI クラス 66
CclException クラス 69
CclMap クラス 80
CclTerminal クラス 92
public メソッド 64, 66, 69, 80, 92
EXEC CICS CONVERSE 168
EXEC CICS RECEIVE 161, 162, 163, 168
EXEC CICS RECEIVE BUFFER 168
EXEC CICS SEND 168
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
exObject
CclException クラス 69
public メソッド 69
ExpiryTime
SecAttr COM クラス
extensible
CclBuf
32
Position
21
52
SetExtAttribute
22
22
SetText 22
Text 22
TextLength 22
external
DataAreaOwner 57
dataAreaOwner 54
Transparency 23
field COM クラス 23, 27, 34, 36, 46
FieldByIndex
ExtractString
メソッド
Buffer COM クラス 2
F
failed
EndTerminalReason
21
Row 21
SetBaseAttribute
52, 53
CclBuf クラス
False
Poll
Intensity 21
Length 21
ResetDataTag
DataAreaType 57
dataAreaType 54
setDataLength 57
FALSE
Validate
Field COM クラス (続き)
メソッド (続き)
98
28
25, 41
false
ErrorWindow 12, 15
Field
Field COM クラス 17
Screen COM クラス 28
field
CclMap クラス 81
CclScreen クラス 83
public メソッド 81, 83
Field COM クラス
メソッド
AppendText 18
BackgroundColor 18
BaseAttribute 19
Column 19
DataTag 19
ForegroundColor 19
Highlight 20
InputProt 20
InputType 20
メソッド
Screen COM クラス
FieldByName
メソッド
Map COM クラス
Validate 28
FieldByPosition
メソッド
Screen COM クラス
29
27
29
FieldCount
メソッド
Screen COM クラス 30
fieldCount
CclScreen クラス 83
public メソッド 83
fields
validate 81
fields (パラメーター)
validate 81, 82
fixed
CclBuf 52, 53
CclBuf クラス 52
DataAreaType 57
dataAreaType 54
Flow
Cancel 5
Changed 5
Commit 47
Connect COM クラス 4
Flow COM クラス 23
Link 7
索引
275
作成日付: 2005年12月2日
Flow (続き)
SetSyncType
Status 9
ForegroundColor
メソッド
Field COM クラス
25
Flow COM クラス
メソッド
CclField クラス
AbendCode 24
CallType 24
CallTypeText
Poll 25
SetSyncType 25
SetTimeout 25
26
Timeout 26
Wait 26
flow (パラメーター)
backout 99
Cancel 5
cancel 59
Changed 5
changed 59
Commit 47
commit 99
in BackOut 47
Link 7
link 60
Status 9
status 62
Flowid
メソッド
Flow COM クラス 24
flowId
CclFlow クラス 77
public メソッド 77
ForceReset
メソッド
Flow COM クラス 24
UOW COM クラス 47
forceReset
CclFlow クラス 77
CclUOW クラス 99
public メソッド 77, 99
SetErrorFormat
13, 16
G
GetDate
SecTime COM クラス
gray
Color
75
green
Color
75
33
H
handleException
CclECI クラス
64
CclEPI クラス 67
public メソッド 64, 67
handleReply
CclFlow クラス 77
CclSession クラス 87
public メソッド 77, 87
Highlight
メソッド
Field COM クラス 20
列挙型 75
CclField クラス 75
highlight
CclField クラス 71
public メソッド 71
Hours
SecTime COM クラス 33
Hundredths
SecTime COM クラス 33
I
idle
send 95
State 88, 97
276
71
public メソッド 71
format (パラメーター)
24
Diagnose 24
Flowid 24
ForceReset 24
SyncType
19
foregroundColor
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
inactive
intense (続き)
CallType 79
index (パラメーター)
intensity
intenseHlt
ExCode
field
15
Highlight
81, 83
75
Intensity
メソッド
Field COM クラス
FieldByIndex 29
in FieldByIndex 29
namedField
72
81
CclField クラス 72
public メソッド 72
internal
ServerDesc 13, 16
serverDesc 65, 67
ServerName 13, 16
serverName 65, 67
validate 81, 82
initEPI
CclBuf 53
DataAreaOwner 57
dataAreaOwner 54
CclEPI コンストラクター
66
CclTerminal コンストラクター
InputProt
メソッド
Field COM クラス
inputProt
CclField クラス 71
public メソッド
InputType
21
intensity
CclMap コンストラクター
invalidState
poll 94
20
send
95
Javadoc
49
80
J
71
メソッド
Field COM クラス
invalidMap
89
20
inputType
CclField クラス 72
public メソッド 72
insert
CclBuf クラス 55
public メソッド 55
InsertString
メソッド
Buffer COM クラス 2
Install
メソッド
Terminal COM クラス 40
install
CclTerminal クラス 93
public メソッド 93
install_path x
instance
CclECI クラス 64
public メソッド 64
intense
BaseInts 74
K
key (パラメーター)
SetAID 30, 84
L
labels
validate 81
LastVerifiedTime
SecAttr COM クラス 32
len
validate 82
Length
メソッド
Buffer COM クラス 3
Field COM クラス 21
length
CclField クラス 72
public メソッド 72
length (パラメーター)
appendText 70
索引
277
作成日付: 2005年12月2日
length (パラメーター) (続き)
Map COM クラス
メソッド
ExCode
assign 53
CclBuf 52, 53
cut
ExtractString
validate
Screen COM クラス
25
46
CclConn クラス 60
public メソッド 60
SetSyncType 25
List パラメーター 134
CICS_EciListSystems 134
CICS_EpiListSystems 関数 147
listState
CclBuf クラス 55
CclConn クラス 60
CclECI クラス 65
CclFlow クラス 78
CclUOW クラス 99
public メソッド 55, 60, 65, 78, 99
M
MakeSecurityDefault
メソッド
Connect COM クラス 7
Terminal COM クラス 40
makeSecurityDefault
CclConn クラス 61
CclTerminal クラス 93
public メソッド 61, 93
Map
Map COM クラス 26
278
30
mapName
メソッド
Connect COM クラス 7
Details 7
UOW COM クラス
link
CallType 79
81
MapName
メソッド
57
SetLength 3
setText 73
Link
Poll
27
Validate 28
map (パラメーター)
2
insert 55
replace 56
setDataLength
27
FieldByName
54
CclScreen クラス 83
public メソッド 83
mapname (パラメーター)
Validate 28
MapSetName
メソッド
Screen COM クラス
mapSetName
CclScreen クラス 83
public メソッド
30
83
MaxBufferSize (パラメーター)
CclBuf クラス 52
maxRequests
CclTerminal コンストラクター
maxServers
serverDesc 67
serverName 67
methodName
CclException クラス 70
public メソッド 70
Minutes
SecTime COM クラス 33
modified
BaseMDT 74
dataTag 71
Month
SecTime COM クラス 34
multipleInstance
CclECI クラス 63
N
n (パラメーター)
position 72
CICS Transaction Gateway: プログラミング・リファレンス
89
作成日付: 2005年12月2日
name (パラメーター)
no (続き)
FieldByName
namedField
poll
normal
27, 28
CclMap クラス 81
protected メソッド
81
NameSpace パラメーター
CICS_EciListSystems 133
78
BaseInts
74
intensity
72
normalHlt
Highlight
CICS_EpiAddTerminal 関数 149
75
notDiscon
CICS_EpiListSystems 関数 147
NetName
メソッド
EndTerminalReason
Nothing
Poll 25
Terminal COM クラス 40
netName
CclTerminal クラス 93
NotifyFn パラメーター
CICS_EpiAddExTerminal 関数 154
CICS_EpiAddTerminal 関数 150
public メソッド
93
numeric
NetName パラメーター
CICS_EpiAddExTerminal 関数 152
CICS_EpiAddTerminal 関数 149
netname (パラメーター)
CclTerminal コンストラクター
neutral
Color
New
98
BaseType 74
inputType 72
nworkName (パラメーター)
Connect 38
SetTermDefns
89, 90
75
Buffer COM クラス 1
Connect COM クラス 5
ECI COM クラス 11
EPI COM クラス 14
Field COM クラス 23, 27, 34, 36, 46
NewPassword パラメーター
CICS_ChangePassword 関数 176
newPassword (パラメーター)
AlterSecurity 37
alterSecurity 59
changed 59
ChangePassword 6
changePassword method 91
in AlterSecurity 5
newstate (パラメーター)
setATI 95
newUserid (パラメーター)
AlterSecurity 5, 37
alterSecurity 59
no
Bool 51
operator!= 56
operator== 56
43
O
off
Bool
51
offset (パラメーター)
cut 54
dataArea 54
ExtractString 2
insert 55
InsertString 2
Overlay 3
replace 56
OldPassword パラメーター
CICS_ChangePassword 関数
on
Bool 51
opaqueTran
Transparency 75
operator!=
CclBuf クラス 56
public メソッド 56
operator+=
CclBuf クラス 55, 56
public メソッド 55, 56
175
索引
279
作成日付: 2005年12月2日
password (パラメーター)
operator=
CclBuf クラス 55
public メソッド 55
alterSecurity method 91
CclConn コンストラクター
CclBuf クラス
ChangePassword
56
public メソッド
orange
Color
Details 6
SetTermDefns
56
75
orTran
Transparency
outofService
75
EndTerminalReason
Overlay
メソッド
98
PF1
AID
84
PF24
AID
84
pink
Color
Poll
43
75
25
Terminal COM クラス
SetSyncType 25, 35
poll
P
PA1
AID
84
PA3
AID
84
paleCyan
Color 75
paleGreen
75
parameter
CclMap コンストラクター 80
CclTerminal コンストラクター 89
send 95
setCursor 84
setExtAttribute 73
Password
メソッド
Connect COM クラス 8
Terminal COM クラス 40
password 59
CclConn クラス 61
CclTerminal クラス 93
public メソッド 61, 93
verifyPassword method 63
Password パラメーター
CICS_EpiSetSecurity 関数 159
CICS_SetDefaultSecurity 関数 179
CICS_VerifyPassword 関数 173
280
37
メソッド
Flow COM クラス
Buffer COM クラス 3
Color
58
CclTerminal コンストラクター
operator==
41
CclFlow クラス 78
CclTerminal クラス 93
public メソッド
PollForReply
メソッド
78, 93
Terminal COM クラス
Position
メソッド
Field COM クラス 21
position
CclField クラス 72
public メソッド 72
programName (パラメーター)
Link 7
link 60
protect
BaseProt 74
inputProt 72
protected メソッド
CclMap クラス 81
namedField 81
validate 81
public メソッド
abendCode 69, 76
alterSecurity 59, 91
appendText 70
assign 53
CICS Transaction Gateway: プログラミング・リファレンス
41
90
作成日付: 2005年12月2日
public メソッド (続き)
backgroundColor
backout 99
baseAttribute
callType
71
71
forceReset 77, 99
foregroundColor 71
handleException
76
callTypeText
cancel 59
public メソッド (続き)
handleReply
77
CclBuf クラス
64, 67
77, 87
highlight 71
inputProt 71
53
inputType
72
CclConn クラス 59
CclECI クラス 64
CclEPI クラス 66
insert 55
install 93
instance 64
CclException クラス 69
CclField クラス 70
CclFlow クラス 76
intensity 72
length 72
link 60
CclMap クラス
listState
80
55, 60, 65, 78, 99
CclScreen クラス 82
CclSession クラス 87
CclTerminal クラス 91
makeSecurityDefault
mapName 83
mapSetName 83
CclUOW クラス 99
CCSid 91
change password 59
methodName 70
netName 93
operator!= 56
changed 59
changePassword
operator+= 55, 56
operator= 55
91
61, 93
className 69
column 71
operator== 56
password 61, 93
commit 99
connection 77
cursorCol 82
cursorRow 82
cut 54
dataArea 54
dataAreaLength 54
dataAreaOwner 54
dataAreaType 54
dataLength 54
dataTag 71
depth 82
diagnose 66, 69, 77, 87, 91
disconnect 91, 92
discReason 92
exCode 64, 66, 69, 80, 92
exCodeText 64, 66, 69, 80, 92
exObject 69
field 81, 83
fieldCount 83
flowId 77
poll 78, 93
position 72
queryATI 94
readTimeout 94
receiveATI 94
replace 56
resetDataTag 72
row 73
screen 95
SecAttr COM クラス 32
SecTime COM クラス 33
send 95
serverCount 65, 67
serverDesc 65, 67
serverName 61, 65, 67, 96
serverStatus 62
serverStatusText 62
setAID 84
setATI 95
setBaseAttribute 73
setCursor 84
索引
281
作成日付: 2005年12月2日
public メソッド (続き)
readTimeOut (パラメーター)
CclTerminal コンストラクター
setDataLength 57
setExtAttribute 73
setText
メソッド
Terminal COM クラス
73
setTimeout
78
CclTerminal クラス 94
public メソッド 94
62
red
syncType 78
termID 96
terminal 88
Color
replace
ECI_ASYNC 呼び出しタイプ
ResetDataTag
メソッド
Field COM クラス
wait 79
width 84
ResetDataTag
21
21
resetDataTag
CclField クラス 72
public メソッド 72
75
Q
41
R
282
114
ECI_STATE_ASYNC 呼び出しタイプ 122
ECI_STATE_SYNC 呼び出しタイプ 118
ECI_SYNC 呼び出しタイプ 106
uowId 99
userId 62, 96
verifyPassword 62, 97
ReadTimeout
メソッド
Terminal COM クラス
readTimeout
CclTerminal クラス 94
public メソッド 94
ReadTimeout (パラメーター)
SetTermDefns 43
56
reserved1
ECI パラメーター・ブロックのフィールド
79
QueryATI
メソッド
Terminal COM クラス
queryATI
CclTerminal クラス 94
public メソッド 94
56
public メソッド
transID 88, 96
transparency 74
uow 79
purple
Color
75
CclBuf クラス
terminate 68
text 74
textLength 74
timeout
42
receiveATI
signonCapability 96
state 67, 87, 96
status
90
ReceiveATI
42
reverseHlt
Highlight 75
Row
メソッド
Field COM クラス 21
row
CclField クラス 73
public メソッド 73
validate 81, 82
row (パラメーター)
field 81, 83
setCursor 84
rowPos (パラメーター)
FieldByPosition 29, 30
SetCursor 31
runTran (パラメーター)
CclConn コンストラクター
TranDetails 9
CICS Transaction Gateway: プログラミング・リファレンス
58
102
作成日付: 2005年12月2日
S
ServerCount
メソッド
Screen
メソッド
Terminal COM クラス 42
Screen
42
Screen COM クラス
Validate
screen
28
28
serverCount
CclECI クラス 65
CclEPI クラス 67
public メソッド
CclTerminal クラス
95
public メソッド 95
Screen COM クラス
メソッド
serverDesc
CclECI クラス
29
FieldByPosition
FieldCount 30
MapName 30
65, 67
ServerDesc
メソッド
ECI COM クラス
EPI COM クラス
ExCode 15
CursorCol 29
CursorRow 29
Depth 29
FieldByIndex
ECI COM クラス 13
EPI COM クラス 16
29
MapSetName 30
SetAID 30
SetCursor 31
Width 31
screen (パラメーター)
CclMap コンストラクター 80
handleReply 87
screenRef (パラメーター)
Validate 28
Screen.fieldbyIndex メソッド
Ccl Field COM クラス 18
Seconds
SecTime COM クラス 34
Send
メソッド
Terminal COM クラス 42
Poll 41
SetSyncType 35
send
CclTerminal クラス 95
public メソッド 95
server
poll 94
State 88, 97
server (パラメーター)
CclTerminal コンストラクター 89, 90
13
16
65
CclEPI クラス 67
public メソッド 65, 67
ServerName
メソッド
Connect COM クラス 8
ECI COM クラス 13
EPI COM クラス 16
Terminal COM クラス
42
Details 6
ExCode 15
serverName
CclConn クラス 61
CclECI クラス 65
CclEPI クラス 67
CclTerminal クラス 96
public メソッド 61, 65, 67, 96
serverName (パラメーター)
CclConn コンストラクター 58
Details 6
ServerStatus
メソッド
Connect COM クラス 8
列挙型 63
CclConn クラス 63
serverStatus
CclConn クラス 62
public メソッド 62
ServerStatusText
メソッド
Connect COM クラス 8
索引
283
作成日付: 2005年12月2日
serverStatusText
setCursor
CclConn クラス 62
public メソッド 62
CclScreen クラス 84
public メソッド 84
servName (パラメーター)
Connect
SetTermDefns
Session
Send
SetData
メソッド
38
Buffer COM クラス
setDataLength
43
CclBuf クラス
42
Session COM クラス
SetSyncType 35
Start 44
34
Field COM クラス
setExtAttribute
CclField クラス 73
public メソッド 73
35
session (パラメーター)
ReceiveATI 42
receiveATI メソッド
94
44
メソッド
Screen COM クラス 30
setAID
CclScreen クラス 84
public メソッド 84
SetATI
メソッド
Terminal COM クラス 43
setATI
CclTerminal クラス 95
public メソッド 95
SetBaseAttribute
メソッド
Field COM クラス 22
setBaseAttribute
CclField クラス 73
public メソッド 73
SetCursor
メソッド
Screen COM クラス 31
284
22
SetLength
メソッド
Buffer COM クラス
Buffer COM クラス 1
Send 42
send 95
Start
SetAID
57
メソッド
35
SetSyncType
State 35
TransId 36
57
ECI COM クラス 13
EPI COM クラス 16
SetExtAttribute
State 45
Session COM クラス
メソッド
Diagnose
public メソッド
SetErrorFormat
メソッド
3
SetString
メソッド
Buffer COM クラス
3
4
SetSyncType
メソッド
Flow COM クラス 25
Session COM クラス 35
SetTermDefns
メソッド
Terminal COM クラス 43
SetText
メソッド
Field COM クラス 22
setText
CclField クラス 73
public メソッド 73
SetTimeout
メソッド
Flow COM クラス 25
setTimeout
CclFlow クラス 78
public メソッド 78
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
State (続き)
shutdown
EndTerminalReason
signoff
98
EndTerminalReason
98
State
state
45
CclEPI クラス
67
CclSession クラス
SignonCapability
メソッド
Terminal COM クラス 44
signonCapability
state (パラメーター)
CclTerminal クラス 96
public メソッド 96
signonCapability (パラメーター)
handleReply 87
stateVal (パラメーター)
SetATI 43
CclTerminal コンストラクター
SetTermDefns 43
signonCapable
signonType
97
列挙型 97
CclTerminal クラス
signonUnknown
90
Status
メソッド
Connect COM クラス
Details
signonIncapable
signonType 97
signonType
signonType 97
Size パラメーター
CICS_EpiReply 関数 163
CICS_EpiStartTran 関数 162
stackPages (パラメーター)
CclFlow 76
Start
メソッド
Terminal COM クラス 44
Poll 41
SetSyncType 35
startData (パラメーター)
Start 44, 45
startdata (パラメーター)
send 95
State
メソッド
EPI COM クラス 17
Session COM クラス 35
Terminal COM クラス 45
列挙型 68, 88, 97
CclEPI クラス 68
CclSession クラス 88
CclTerminal クラス 97
EPI COM クラス 13
9
7
Poll 25
status
CallType
97
87
CclTerminal クラス 96
public メソッド 67, 87, 96
79
CclConn クラス 62
public メソッド 62
ServerStatus 8
ServerStatusText 8
SetSyncType 25
String
メソッド
Buffer COM クラス 4
string (パラメーター)
AppendString 2
InsertString 2
Overlay 3
SetString 4
Sync
列挙型 51
Ccl クラス 51
sync
CclSession コンストラクター
Sync 51
SyncType
メソッド
Flow COM クラス 26
syncType
CclFlow クラス 78
poll 78, 94
public メソッド 78
wait 79
87
索引
285
作成日付: 2005年12月2日
Terminal COM クラス (続き)
メソッド (続き)
syncType (パラメーター)
CclFlow 76
CclSession コンストラクター
SetSyncType
SyncType
ExCodeText
Install 40
87
25, 35
MakeSecurityDefault
26
System パラメーター
CICS_ChangePassword 関数 176
CICS_EpiAddExTerminal 関数 152
CICS_EpiAddTerminal 関数 149
CICS_SetDefaultSecurity 関数 179
CICS_VerifyPassword 関数 173
40
Password
Poll 41
40
40
41
QueryATI 41
ReadTimeout 42
ReceiveATI 42
Screen 42
Send 42
ServerName
133
CICS_EpiListSystems 関数 147
SetATI
42
43
SetTermDefns 43
SignonCapability 44
Start 44
T
State 45
TermId 45
TransId 45
termDefined
State 98
TermId
メソッド
Terminal COM クラス
termID
CclTerminal クラス 96
public メソッド 96
Terminal
EPI COM クラス 13
Screen COM クラス 28
ServerName 43
terminal
CclSession クラス 88
public メソッド 88
Terminal COM クラス
メソッド
AlterSecurity 37
CCSId 37
ChangePassword 37
Connect 38
Devtype 38
Diagnose 38
Disconnect 38
DisconnectWithPurge 39
DiscReason 39
ExCode 39
286
NetName
PollForReply
SystemName パラメーター
CICS_EciListSystems 133
Systems パラメーター 134
CICS_EciListSystems
39
Userid 45
VerifyPassword
45
46
Terminal.Connect
Screen COM クラス
28
Terminal.Screen
Screen COM クラス 28
Terminate
メソッド
EPI COM クラス 17
Terminate 17
terminate
CclEPI クラス 68
public メソッド 68
TermIndex パラメーター
CICS_EpiAddExTerminal 関数 154
CICS_EpiAddTerminal 関数 150
CICS_EpiATIState 関数 165
CICS_EpiDelTerminal 関数 157
CICS_EpiGetEvent 関数 166
CICS_EpiInquireSystem 関数 156
CICS_EpiPurgeTerminal 関数 158
CICS_EpiReply 関数 163
CICS_EpiSetSecurity 関数 159
CICS_EpiStartTran 関数 161
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
TransId パラメーター
Text
メソッド
Field COM クラス
22
CICS_EpiStartTran 関数
transid (パラメーター)
text
send
CclField クラス
74
メソッド
Field COM クラス
列挙型
70
setText 73
TextLength
メソッド
22
Validate
True
Poll
true
textLength
CclField クラス 74
public メソッド 74
28
25, 41
ErrorWindow
txnTimedOut
State 98
textString (パラメーター)
AppendText 18
SetText 22
12, 15
type (パラメーター)
CclBuf 52, 53
Timeout
メソッド
Flow COM クラス
timeout
23
75
CclField クラス 75
transparency
CclField クラス 74
public メソッド 74
TRUE
CclBuf 53
operator+= 56
operator= 55
Field COM クラス
95
Transparency
public メソッド 74
text (パラメーター)
appendText
161
26
CclFlow クラス 79
public メソッド 79
timeout (パラメーター)
CclFlow 76
Install 40
setTimeout 78
tranCode (パラメーター)
in Start 44
Start 45
TranDetails
メソッド
Connect COM クラス 9
Connect COM クラス 4
TransId
メソッド
Session COM クラス 36
Terminal COM クラス 45
transID
CclSession クラス 88
CclTerminal クラス 96
public メソッド 88, 96
U
unavailable
ServerStatus 63
underscoreHlt
Highlight 75
unit (パラメーター)
link 60
unitOfWork (パラメーター)
Link 7
unknown
EndTerminalReason 98
ServerStatus 63
unknownServer
CclTerminal コンストラクター
unmodified
BaseMDT 74
dataTag 71
unmodified (パラメーター)
resetDataTag 72
unpadded (パラメーター)
status 61, 62
89
索引
287
作成日付: 2005年12月2日
UnpaddedPassword
userID (パラメーター)
メソッド
Connect COM クラス
CclConn コンストラクター
Details 6
9
UnpaddedServerName
userId (パラメーター)
メソッド
CclConn コンストラクター
Connect COM クラス
UnpaddedUserid
10
alterSecurity method
Connect COM クラス
unprotect
BaseProt 74
UOW COM クラス
V
46
uow
CclFlow クラス 79
public メソッド 79
UOW COM クラス
メソッド
BackOut 47
Commit 47
ForceReset 47
UowId
47
UowId
メソッド
UOW COM クラス 47
uowId
CclUOW クラス 99
public メソッド 99
UserId
メソッド
Connect COM クラス 10
Userid
メソッド
Terminal COM クラス 45
userId
CclConn クラス 62
CclTerminal クラス 96
public メソッド 62, 96
UserId パラメーター
CICS_ChangePassword 関数 175
CICS_EpiSetSecurity 関数 159
CICS_SetDefaultSecurity 関数 179
CICS_VerifyPassword 関数 173
288
91
CclTerminal コンストラクター
SetTermDefns 43
10
72
58
Details 6
userid (パラメーター)
メソッド
inputProt
UOW
Link 7
58
Validate
メソッド
Map COM クラス
validate
28
CclMap クラス 81
protected メソッド 81
Value (パラメーター)
SetExtAttribute 22
value (パラメーター)
setExtAttribute
VerifyPassword
メソッド
73
Connect COM クラス
10
Terminal COM クラス 46
verifyPassword
CclConn クラス 62
CclTerminal クラス 97
public メソッド 62, 97
Version パラメーター
CICS_EpiInitialize 関数 145
W
Wait
メソッド
Flow COM クラス 26
Wait 26
wait
CclFlow クラス 79
public メソッド 79
Wait パラメーター
CICS_EpiGetEvent 関数 166
CICS Transaction Gateway: プログラミング・リファレンス
90
作成日付: 2005年12月2日
white
Color
Width
75
メソッド
Screen COM クラス 31
width
CclScreen クラス
public メソッド
84
84
validate 81
withPurge
disconnect メソッド
CclTerminal クラス 92
X
xorTran
Transparency
75
Y
Year
SecTime COM クラス 34
yellow
Color
75
yes
Bool 51
operator!= 56
operator== 56
poll 78
［特殊文字］
(パラメーター)
changed 59
<install_path>
x
索引
289
作成日付: 2005年12月2日
290
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
特記事項
本書は米国 IBM が提供する製品およびサービスについて作成したものであり、本書に
記載の製品、サービス、または機能が日本においては提供されていない場合がありま
す。日本で利用可能な製品、サービス、および機能については、日本 IBM の営業担当
員にお尋ねください。本書で IBM 製品、プログラム、またはサービスに言及していて
も、その IBM 製品、プログラム、またはサービスのみが使用可能であることを意味す
るものではありません。これらに代えて、IBM の知的所有権を侵害することのない、機
能的に同等の製品、プログラム、またはサービスを使用することができます。ただし、
IBM 以外の製品とプログラムの操作またはサービスの評価および検証は、お客様の責任
で行っていただきます。
IBM は、本書に記載されている内容に関して特許権 (特許出願中のものを含む) を保有
している場合があります。本書の提供は、お客様にこれらの特許権について実施権を許
諾することを意味するものではありません。実施権についてのお問い合わせは、書面に
て下記宛先にお送りください。
〒106-0032
東京都港区六本木 3-2-31
IBM World Trade Asia Corporation
Licensing
以下の保証は、国または地域の法律に沿わない場合は、適用されません。 IBM および
その直接または間接の子会社は、本書を特定物として現存するままの状態で提供し、商
品性の保証、特定目的適合性の保証および法律上の瑕疵担保責任を含むすべての明示も
しくは黙示の保証責任を負わないものとします。国または地域によっては、法律の強行
規定により、保証責任の制限が禁じられる場合、強行規定の制限を受けるものとしま
す。
この情報には、技術的に不適切な記述や誤植を含む場合があります。本書は定期的に見
直され、必要な変更は本書の次版に組み込まれます。 IBM は予告なしに、随時、この
文書に記載されている製品またはプログラムに対して、改良または変更を行うことがあ
ります。
本書において IBM 以外の Web サイトに言及している場合がありますが、便宜のため
記載しただけであり、決してそれらの Web サイトを推奨するものではありません。そ
れらの Web サイトにある資料は、この IBM 製品の資料の一部ではありません。それ
らの Web サイトは、お客様の責任でご使用ください。
本プログラムのライセンス保持者で、(i) 独自に作成したプログラムとその他のプログラ
ム（本プログラムを含む）との間での情報交換、および (ii) 交換された情報の相互利用
© Copyright IBM Corp. 1989, 2005
291
作成日付: 2005年12月2日
を可能にすることを目的として、本プログラムに関する情報を必要とする方は、下記に
連絡してください。 IBM Corporation, MP151, Hursley Hampshire Drop 1329, England
SO21 2JN USA 本プログラムに関する上記の情報は、適切な使用条件の下で使用するこ
とができますが、有償の場合もあります。
本書で説明されているライセンス・プログラムまたはその他のライセンス資料は、IBM
所定のプログラム契約の契約条項、IBM プログラムのご使用条件、またはそれと同等の
条項に基づいて、 IBM より提供されます。
IBM 以外の製品に関する情報は、その製品の供給者、出版物、もしくはその他の公に利
用可能なソースから入手したものです。IBM は、それらの製品のテストは行っておりま
せん。したがって、他社製品に関する実行性、互換性、またはその他の要求については
確証できません。 IBM 以外の製品の性能に関する質問は、それらの製品の供給者にお
願いします。
著作権使用許諾:
本書には、様々なオペレーティング・プラットフォームでのプログラミング手法を例示
するサンプル・アプリケーション・プログラムがソース言語で掲載されています。お客
様は、サンプル・プログラムが書かれているオペレーティング・プラットフォームのア
プリケーション・プログラミング・インターフェースに準拠したアプリケーション・プ
ログラムの開発、使用、販売、配布を目的として、いかなる形式においても、IBM に対
価を支払うことなくこれを複製し、改変し、配布することができます。このサンプル・
プログラムは、あらゆる条件下における完全なテストを経ていません。従って IBM
は、これらのサンプル・プログラムについて信頼性、利便性もしくは機能性があること
をほのめかしたり、保証することはできません。
商標
以下は、IBM Corporation の商標です。
AIX
CICS
CICS/VSE
DB2
IBM
IBMLink™
MVS
OS/2
POWER
RACF
Redbooks
292
CICS Transaction Gateway: プログラミング・リファレンス
作成日付: 2005年12月2日
System/390
TXSeries
z/OS
Microsoft、Windows、 Windows NT®、および Windows ロゴは、Microsoft Corporation
の米国およびその他の国における商標です。
Java 、およびすべての Java 関連の商標およびロゴは、Sun Microsystems, Inc. の米国お
よびその他の国における商標または登録商標です。
UNIX は、The Open Group の米国およびその他の国における登録商標です。
Intel® 、Intel Inside (ロゴ) 、MMX™ および Pentium® は、Intel Corporation の米国お
よびその他の国における商標です。
Linux は、Linus Torvalds の米国およびその他の国における商標です。
他の会社名、製品名およびサービス名等はそれぞれ各社の商標です。
特記事項
293
作成日付: 2005年12月2日
294
CICS Transaction Gateway: プログラミング・リファレンス
򔻐򗗠򙳰
プログラム番号: 5655-M69
作成日付: 2005年12月2日
SD88-6665-00