3.2 ライブラリ関数の記述方法

各ライブラリ関数の記述方法を次の形式で説明します。

<この節の構成>
(1) 名称
(2) 形式
(3) 機能
(4) リターン情報
(5) 注意事項

(1) 名称

ライブラリ関数の名称と,機能の概要について説明しています。

(2) 形式

ライブラリ関数の使用方法をコーディングレベルで記述しています。

(3) 機能

ライブラリ関数の詳細な機能,および引数を説明しています。また,構造体を設定・参照する必要がある場合は,その形式および内容を説明しています。

(4) リターン情報

(a) リターン値

HDLCパススルーAPIが,ライブラリ関数の実行結果を報告するために,アプリケーションプログラムに対して返す値を説明しています。一般に,0または正の値は関数が正しく終了したことを示し,-1は関数が異常終了したことを示します。

(b) エラー情報

ライブラリ関数が異常終了した場合に,グローバル変数d_errnoにセットされるエラーコード(10進)を説明しています。なお,各エラーコードに対応するエラー名称がヘッダファイルdiuser.hに設定されているので,参照してください。

(5) 注意事項

ライブラリ関数を使用するときに注意しなければならない点について説明しています。