5.1.2　COBOL-UAP作成用プログラムの記述形式

CUPをCOBOL言語で作成するときは，TP1/Clientのライブラリにある関数に対応したCOBOL-UAP作成用プログラムをCALL文で呼び出します。

「6.　TP1/Clientで使用できる要求文（COBOL言語編）」では，COBOL-UAP作成用プログラムを次の形式で説明します。

形式

ライブラリにある関数と対応するCOBOL-UAP作成用プログラムをCALL文で呼び出す形式と，領域の指定方法を示します。

データ名に値を指定するときは，ここで示すPICTURE句のデータ形式に従ってください。指定する値が決まっている場合はVALUE句で記述してあります。

一意名で示すファイル名とデータ名には，断りがないかぎり，固有の名称を任意に付けてください。

データ名として指定する文字の長さなどは，使用するCOBOLの仕様に従ってください。

機能

COBOL-UAP作成用プログラムの機能について説明します。以降，COBOL-UAP作成用プログラムを，次に示す形式で表記します。

CBLDCXXX('YYYYYYYY')
 
CBLDCXXX：COBOL-UAP作成用プログラムのプログラム名を示します。
YYYYYYYY：要求コードを示します。

UAPで値を設定するデータ領域

DATA DIVISIONに指定するデータのうち，COBOL-UAP作成用プログラムの呼び出し時にデータ領域に値を指定しておくデータ名です。各データ名の説明に従って，値を設定してください。

値が返されるデータ領域

CALL文を実行したあとに，OpenTP1，サーバUAP，TP1/Clientなどから値が返されるデータ名です。

ステータスコード

CALL文を実行したときに返される値を，表形式で説明します。ステータスコードによって，COBOL-UAP作成用プログラムが正常に実行されたかどうかがわかります。エラーが発生したときは，エラーの内容を示します。

COBOL言語のステータスコードは5けたの数字列で，USING句で指定する最初の一意名に含まれます。CALL文のUSING句で指定する一意名とステータスコードの関係を次に示します。

[図データ]

注意事項

COBOL-UAP作成用プログラムを使うときの注意を記述します。

〈この項の構成〉

(1)　指定する項目の説明で使う記号

指定する項目の説明で使う記号の一覧を示します。

記号	説明
〔　〕	この記号で囲まれている項目は，省略しても良いことを示します。（例）〔:ポート番号〕 :ポート番号は省略できることを示します。
…	記述が省略されていることを示します。この記号の直前に示された項目を繰り返し複数個指定できます。（例）ホスト名〔:ポート番号〕〔,ホスト名〔:ポート番号〕,…〕ホスト名〔:ポート番号〕を続けて指定できることを示します。
△	空白を示します。
〜	この記号の前に示された項目が，〜に続く〈　〉，((　))の規則に従うことを示します。
〈文字列〉	任意の文字の配列を示します。
〈符号なし整数〉	数字（0〜9）を示します。
((　))	指定値の指定範囲を示します。