10.3.3 ライブラリ関数の説明形式
ライブラリ関数の文法を、次の形式で説明します。
- 形式
-
ライブラリ関数の形式と、パラメタ項目のデータ型を示します。
ANSI Cの形式でコーディングする場合は「ANSI C形式」に従ってください。
パラメタ項目に値を設定するときは、ここで示すデータ型に従ってください。特に断りがないかぎり、パラメタ項目には固有の名称を任意で付けられます。
- 機能
-
ここで説明する関数の機能について説明します。
- UAPが設定するパラメタ項目
-
関数の実行時に、値を指定しておくパラメタ項目を示します。各パラメタ項目の説明に従って、値を設定してください。
- システム検証支援基盤から値が返されるパラメタ項目
-
関数を実行したあとに、システム検証支援基盤から値が返されるパラメタ項目（データ領域含む）です。関数の実行後にこのパラメタ項目の内容を参照してください。
- リターン値
-
関数を実行したときに戻ってくる値を、表形式で説明します。このリターン値によって、関数が正常に実行されたかどうかがわかります。エラーが起こったときは、エラーの内容を示します。
UAPを作成するときは、互換性を保つために、必ずここで示す定数名でリターン値を使ってください。リターン値の定数名は、ヘッダファイルで定義されています。リターンされる値の情報が必要なときは、ヘッダファイルの定義を参照してください。
- 指定例
-
指定例が必要な関数には記述します。
- 注意事項
-
関数を使うときの注意について記述します。