3.1.2 関数の記述形式
「4. TP1/Clientで使用できる関数（C言語編）」では，使用する関数を次の形式で説明します。
- 形式
-
TP1/Clientのライブラリで提供する関数の定義形式と，引数のデータ型を示します。引数に値を指定するときは，ここで示すデータ型に従ってください。
- 機能
-
ここで説明する関数の機能を説明します。
- UAPで値を設定する引数
-
関数の実行時に，値を指定しておく引数を示します。各引数の説明に従って，値を指定してください。
- 値が返される引数
-
関数を実行したあとに，OpenTP1，サーバUAP，TP1/Clientなどから値が返される引数です。
- リターン値
-
関数を実行したときに戻ってくる値を，表形式で説明します。このリターン値によって，関数が正常に実行されたかどうかがわかります。エラーが発生したときは，エラーの内容を示します。
UAPを作成するときは，数値ではなく，必ずここで示す定義名でリターン値を使用してください。リターン値の定数名はヘッダファイルで定義されています。
- 注意事項
-
関数を使用するときに注意しなければならないことを示します。
- 〈この項の構成〉
(1) 引数に指定する値の説明で使う記号
関数の引数に指定する値の説明で使う記号の一覧を示します。
|
記号 |
説明 |
|---|---|
|
｛ ｝ |
この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目の区切りは｜で示します。
|
|
〔 〕 |
この記号で囲まれている項目は，省略しても良いことを示します。
|
|
＿ （下線） |
括弧〔 〕で囲まれた複数の項目のうちで，括弧内のすべてを省略したときに，TP1/Clientで仮定する標準値を示します。
|
|
… |
記述が省略されていることを示します。この記号の直前に示された項目を繰り返し複数個指定できます。
|
|
〜 |
この記号の前に示された項目が，〜に続く〈 〉，(( ))に従うことを示します。 |
|
〈文字列〉 |
任意の文字の配列を示します。 |
|
〈符号なし整数〉 |
数字（0〜9）を示します。 |
|
(( )) |
指定値の指定範囲を示します。 |