リファレンス・ガイド

新規ウィンドウで目次を開く

新規ウィンドウで索引を開く

ATMIからCPI-Cへの関数マッピング

次の表は、最も一般的なATMI関数呼出しを一覧し、そのパラメータとCPI-C動詞のマッピング方法を示しています。マッピングは関数呼出し別に次の順序で示されます。

この表は、ATMI呼出しのパラメータ、パラメータの内容や意味、およびCPI-C動詞と使用する際の注意点を示しています。

表1-1 tpcall
tpcall()	パラメータ	内容	CPI-Cの注記
svc		サービス名	CMALLCで起動対象のCICSトランザクションを識別するために使用します。
idata		ユーザー・データ	送信が完了するまでこのデータがCMSENDで送信されます。
len		ユーザー・データの長さ
odata		応答データ	送信が完了するまでCMRCVがデータを受け取り(data_receivedがCM_COMPLETE_DATA_RECEIVEDに設定され)、リターン・コードはCM_OKまたはCM_DEALLOCATE_NORMALに設定されます。
olen		応答データの長さ
flags	`TPNOTRAN`	トランザクションの一部ではない
	`TPNOCHANGE`	該当なし	ローカル
	`TPNOBLOCK`	該当なし	ローカル
	`TPNOTIME`	該当なし	ローカル
	`TPSIGRSTRT`	該当なし	ローカル

表1-2 tpacall
tpacall()	パラメータ	内容	CPICの注記
svc		サービス名	CMALLCで起動対象のCICSトランザクションを識別するために使用します。
data		ユーザー・データ	送信が完了するまでこのデータがCMSENDで送信されます。
len		ユーザー・データの長さ
flags	`TPNOREPLY`	false	CMSENDにより、最新データがsend_type CMSEND_AND_PREP_TO_RECEIVEの設定で送信されました。これにより、対話状態が受信に変更され、応答待ちのためCMRCVが発行されます。
	`TPNOREPLY`	true	応答が返ってくることが想定されないため、CMDEALはすべてのデータを受信した後、対話を割当て解除します。
	`TPNOTRAN`	トランザクションの一部ではない
	`TPNOBLOCK`	該当なし	ローカル
	`TPNOTIME`	該当なし	ローカル
	`TPSIGRSTRT`	該当なし	ローカル

表1-3 tpgetrply
tpgetrply()	パラメータ	内容	CPICの注記
cd		呼出し記述子	呼出し記述子はLU6.2が初期化されている場合はCMINITから戻されるCONVIDにマップされます。
data		ユーザー・データ	WHAT_RECEIVEDがDATA_COMPLETEに設定されている場合にCMRCVから戻されるデータ。
len		ユーザー・データの長さ
flags	`TPGETANY`	trueの場合、データは任意の対話から戻されます。falseの場合、データは`cd`に関連付けられている対話から返されます。	任意の対話で使用可能なデータがリクエスタに戻されます。
	`TPNOCHANGE`	ローカルからリクエスタ	サポートされているバッファ・タイプは限定されます。
	`TPNOBLOCK`	該当なし	ローカル
	`TPNOTIME`	該当なし	ローカル
	`TPSIGRSTRT`	該当なし	ローカル

表1-4 tpservice
tpservice()	パラメータ	内容	CPICの注記
svcinfo		サービス情報およびデータ	CMRCVから取得したユーザー・データが、TPSVCINFO構造ユーザー・データ・エリアに移入されます。サービス特性はDMCONFIGファイルおよびUBBCONFIGファイルのサービス属性から取得されます。
name		サービス名	CICSから送信された8文字のRNAMEに関連付けられているサービス名。
data		ユーザー・データ	CMRCVから取得したデータ。
len		ユーザー・データの長さ
cd		呼出し記述子	LU6.2が初期化されている場合に、CMINITにより戻される、CONVIDに関連付けられている呼出し記述子。
appkey		32ビット・キー(使用されている場合)	セキュリティ用。
cltid		Oracle Tuxedoにより設定	セキュリティ用。
flags	`TPCONV`	trueの場合、サービスは対話型です。
	`TPTRAN`	該当なし	.
	`TPNOREPLY`	trueの場合、リクエスタは応答が返ってくることを想定しません。	対話は通常のCMDEALで終了します。
	`TPSENDONLY`	該当なし	設定した場合、CICSでのCPICの対話は受信状態になります。設定しない場合、CICS CPICの対話の状態は送信状態になります。
	`TPRECVONLY`	該当なし	設定した場合、CICSでのCPICの対話は送信状態のままです。

表1-5 tpreturn
tpreturn()	パラメータ	内容	CPICの注記
rval		`TPSUCCESS`	対話が通常の割当て解除で終了する場合はTPSUCCESSに設定します。
rval		`TPSVCERR`	対話が通常以外の割当て解除タイプやその他のエラーで終了する場合はTPESVCERRに設定します。
rcode		アプリケーションにより設定	該当なし
data		ユーザー・データ	戻りデータがCM_DATA_COMPLETEに設定され、リターンコードがCM_DEALLOCATE_NORMALで、成功したCMRCVからCICSトランザクションにデータが戻されます。サービスに失敗した場合は、呼出し元にデータは戻されず、対話は異常な状態で割当て解除されます。
len		戻りデータ長	0 < データ <= 32K
flags		該当なし	該当なし

表1-6 tpcancel
tpcancel()	パラメータ	内容	CPICの注記
cd		`tpgetreply()`が待機している接続記述子。	呼出し記述子からマップされているCONVIDとの対話でCMDEALの異常が発行されます。

表1-7 tpconnect
tpconnect()	パラメータ	内容	CPICの注記
svc		CICSの起動対象のサービスを示すローカル・サービス名。	RNAMEの検索に使用する名前。RNAMEはCICSのTPNameと一致している必要があり、CMINITおよびCMALLCによって対話の起動および割当てに使用されます。
data		ユーザー・データ	送信が完了するまでこのデータがCMSENDで送信されます。
len		ユーザー・データの長さ
flags	`TPNOTRAN`	true
	`TPSENDONLY`	trueの場合、対話は維持されるか、送信状態に変更されます。	対話は送信状態のままです。これがデフォルトです。
	`TPRECVONLY`	trueの場合、対話は維持されるか、受信状態に変更されます。	Oracle Tuxedoの割当ての直後にデータなしのCMSENDがsend_type CM_SEND_AND_PREP_TO_RECEIVEの設定で送信されます。
	`TPNOBLOCK`	該当なし	ローカル
	`TPNOTIME`	該当なし	ローカル
	`TPSIGRSTRT`	該当なし	ローカル

表1-8 tpsend
tpsend()	パラメータ	内容	CPICの注記
cd		接続記述子	このローカル割当ての接続記述子は、CMINITおよび`tpconnect()`のかわりのCMALLCで戻されるCONVIDにマップされています。
data		ユーザー・データ	CICSへの送信前にASCII/EBCDIC変換が必要になる場合があります。
len		ユーザー・データの長さ
flags	`TPRECVONLY`	trueの場合、対話は受信状態に変更されます。	対話の状態は送信から受信に変更されます。CMSENDがsend_type CM_SEND_AND_PREP_TO_RECEIVEの設定で送信されます。
	`TPNOBLOCK`	該当なし	ローカル
	`TPNOTIME`	該当なし	ローカル
	`TPSIGRSTRT`	該当なし	ローカル
revent	`TPEV_DISCONIMM`	設定されている場合、LU6.2対話が異常終了しています。	CMRCVからのリターン・コードがdeallocate_abnormalである場合、対話は終了します。切断イベントが送信プロセスに送信されます。
	`TPEV_SVCERR`	設定されている場合、LU6.2対話が異常終了しています。	CM_OKまたはCM_DEALLOCATE_NORMAL以外のリターン・コードはTPEV_SVCERRとして扱われます。
	`TPEV_SVCFAIL`	設定されている場合、LU6.2対話が異常終了しています。	CMRCVからのリターン・コードがCM_TP_NOT_AVAIL_NO_RETRYまたはCM_TP_RESOURCE_FAILURE_NO_RETRYの場合、`revent`がTPEV_SVCFAILに設定されます。

表1-9 tprecv
tprecv()	パラメータ	内容	CPICの注記
cd		接続記述子	このローカル割当ての接続記述子は、この対話のイニシエータが発行したCMINITおよびCMALLCに戻されるCONVIDにマップされています。
data		ユーザー・データ	CMRCV_immediateを使用して受信し、Oracle Tuxedoサービスに戻される日付。
len		ユーザー・データの長さ
flags	`TPNOCHANGE`	ローカル	サポートされているバッファ・タイプである必要があります。
	`TPNOBLOCK`	該当なし	ローカル
	`TPNOTIME`	該当なし	ローカル
	`TPSIGRSTRT`	該当なし	ローカル
revent	`TPEV_DISCONIMM`	設定されている場合、LU6.2対話が異常終了しています。	CMSENDからのリターン・コードがdeallocate_abnormalの場合、対話は終了します。切断イベントが送信処理に送信されます。
	`TPEV_SENDONLY`	設定されている場合、パートナが許可すれば、LU6.2対話は送信に変更されます。	send_typeがCM_SEND_AND_PREP_TO_RECEIVEの設定で送信パートナがCMSENDを送信しています。
	`TPEV_SVCERR`	設定されている場合、LU6.2対話が異常終了しています。	CM_OKまたはCM_DEALLOCATE_NORMAL以外のリターン・コードはTPEV_SVCERRとして扱われます。
	`TPEV_SVCFAIL`		CMRCVからのリターン・コードがCM_TP_NOT_AVAIL_NO_RETRYまたはCM_TP_RESOURCE_FAILURE_NO_RETRYの場合、`revent`がTPEV_SVCFAILに設定されます。
	`TPEV_SVCSUCC`	設定されている場合、対話は正常に完了しています。	CMRCVからのリターン・コードはCM_DEALLOCATE_NORMALに設定されています。これは、送信TPが完了し、対話が正常に割当て解除されたことを示します。

表1-10 tpdiscon
tpdiscon()	パラメータ	内容	CPICの注記
cd		接続記述子	この接続記述子は、CMINITまたはCMACCPから対話の発信者に戻されるCONVIDにマップされています。

表1-11 tpforward
tpforward ()	パラメータ	内容	CPICの注記
svc		サービス名	tpforward()は`tpacall()`であったとして扱われます。CMINITおよび後に続くCMALLCが、対話のセッション初期化と割当てのために発行されます。クライアントIDはTPSVCINFOレコード内のCICSトランザクションに伝播する必要があります。
data		ユーザー・データ	データはCMSENDを使用して送信されます。最後のCMSENDはsend_typeがdeallocate_normaLの設定で送信されます。
len		戻りデータ長
flags		`tpacall`()を参照してください。