通信管理 XNF/AS プログラマーズガイド HSC編

[目次][用語][索引][前へ][次へ]

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

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

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

(1) 名称

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

(2) 形式

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

(3) 機能

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

(4) リターン情報

(a) リターン値

HSC-APIが,ライブラリ関数の実行結果を報告するためにアプリケーションプログラムに対して返す値を説明しています。

一般的に,0または正の値は関数が正しく終了したことを意味し,-1は関数が異常終了したことを意味します。

(b) 詳細エラー情報

ライブラリ関数が異常終了した場合に,グローバル変数errnoにセットされるエラーコードの詳細情報を説明しています。

(c) LCBリターン情報

LCBを引数に持つライブラリ関数が完了した場合に,終了コードと異常終了時のエラー詳細コードがLCBリターン情報に設定されます。ただし非同期方式の場合は,LCBリターン情報に結果は設定されないので,BT_CHECK関数などで結果を確認してください。

LCBリターン情報の詳細については,「3.26 LCB」を参照してください。

(5) 特記事項

ライブラリ関数を使用する際の特記事項および注意事項について説明しています。