8.3 記述形式

このマニュアルでは,原則,次に示す形式でライブラリ関数の説明をしています。

  1. 機能概要
    通信管理が提供するライブラリ関数の機能概要を説明しています。
  2. 書き方
    ライブラリ関数の呼び出し方を,C言語を使用してコーディングレベルで記述しています。
  3. リターン情報
    通信管理がアプリケーションに報告する内容を説明しています。リターン情報には次の三つがあります。
    • リターンコード:リターンコードの種類とその説明
    • 詳細エラー情報:発生したエラーの詳細説明
    • 詳細エラーコード:通信記述部のO_statusに設定する詳細のエラーコード
  4. 特記事項
    ライブラリ関数についての特記事項を説明しています。