関数の記述形式

分散トランザクション処理機能　OpenTP1 クライアント使用の手引 TP1/Client/W，TP1/Client/P編

「4.　TP1/Clientで使用できる関数（C言語編）」では，使用する関数を次の形式で説明します。

形式: TP1/Clientのライブラリで提供する関数の定義形式と，引数のデータ型を示します。引数に値を指定するときは，ここで示すデータ型に従ってください。

リターン値: 関数を実行したときに戻ってくる値を，表形式で説明します。このリターン値によって，関数が正常に実行されたかどうかがわかります。エラーが発生したときは，エラーの内容を示します。; UAPを作成するときは，数値ではなく，必ずここで示す定義名でリターン値を使用してください。リターン値の定数名はヘッダファイルで定義されています。

関数の引数に指定する値の説明で使う記号の一覧を示します。

記号	説明
｛　｝	この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目の区切りは｜で示します。（例）｛DCCLT_CNV_EBCDIC｜DCCLT_CNV_EBCDIK｝ DCCLT_CNV_EBCDICとDCCLT_CNV_EBCDIKの二つの項目で，どちらかを指定することを示します。
〔　〕	この記号で囲まれている項目は，省略しても良いことを示します。（例）〔DCNOFLAGS〕 DCNOFLAGSは省略できることを示します。
＿（下線）	括弧〔　〕で囲まれた複数の項目のうちで，括弧内のすべてを省略したときに，TP1/Clientで仮定する標準値を示します。（例）〔｛DCCLT_CNV_SPCHAN｜DCCLT_CNV_SPCZEN｝〕 DCCLT_CNV_SPCHAN，DCCLT_CNV_SPCZENの両方とも省略した場合，DCCLT_CNV_SPCZENを仮定します。
…	記述が省略されていることを示します。この記号の直前に示された項目を繰り返し複数個指定できます。（例）ホスト名〔:ポート番号〕〔,ホスト名〔:ポート番号〕,…〕ホスト名〔:ポート番号〕を続けて指定できることを示します。
～	この記号の前に示された項目が，～に続く〈　〉，((　))に従うことを示します。
〈文字列〉	任意の文字の配列を示します。
〈符号なし整数〉	数字（0～9）を示します。
((　))	指定値の指定範囲を示します。

引数として指定する記号を示します。

記号	説明
｜（ストローク）	一つの引数に複数の項目を指定するときに，項目同志の区切りを示します。この記号を項目と項目の間に入れて指定してください。（例）｛DCCLT_CNV_EBCDIC｜DCCLT_CNV_EBCDIK｝〔｜｛DCCLT_CNV_SPCHAN｜DCCLT_CNV_SPCZEN｝〕 DCCLT_CNV_EBCDICとDCCLT_CNV_SPCHANを指定するときは，「DCCLT_CNV_EBCDIC｜DCCLT_CNV_SPCHAN」と指定します。

記号

説明

｜
（ストローク）

一つの引数に複数の項目を指定するときに，項目同志の区切りを示します。
この記号を項目と項目の間に入れて指定してください。

（例）｛DCCLT_CNV_EBCDIC｜DCCLT_CNV_EBCDIK｝: 〔｜｛DCCLT_CNV_SPCHAN｜DCCLT_CNV_SPCZEN｝〕

DCCLT_CNV_EBCDICとDCCLT_CNV_SPCHANを指定するときは，
「DCCLT_CNV_EBCDIC｜DCCLT_CNV_SPCHAN」と指定します。