5.2 記述形式

ライブラリ関数は,次のような形式で説明しています。ただし,必ずしもすべての項目を含んでいるとは限りません。

<この節の構成>
(1) 機能概要
(2) 構文
(3) 設定情報
(4) リターン情報
(5) 特記事項

(1) 機能概要

NLIが提供するライブラリ関数の機能概要を記述しています。

(2) 構文

ライブラリ関数の構文をC言語を使用して記述しています。

(3) 設定情報

ライブラリ関数の引数について説明しています。

(4) リターン情報

NLIがアプリケーションに報告する内容を説明しています。

(a) リターン情報

リターンコードの種類とその意味を説明しています。

(b) 詳細エラーコード

異常終了発生時の詳細なエラーコードとその意味を説明しています。

(5) 特記事項

ライブラリ関数に関する特記事項を説明しています。