付録D.3 関数の記述形式

<この項の構成>
(1) データ項目の検査関数
(2) 業務ルールの検査関数
(3) エラーIDからメッセージの取得関数
(4) エラーID領域の解放関数

(1) データ項目の検査関数

データ項目の定義情報をチェックし,その結果をResultに返します。

(a) 関数名

DscCheckItem-データ項目の定義情報チェック

(b) 形式

Dsc_status_t DscCheckItem(
 const Dsc_item_struct_t    *Item,
                         /* データ項目情報構造体 */
 Dsc_err_id_t              **ErrIDList,
                         /* エラーID配列        */
 Dsc_int_t                  *ErrCount,
                         /* エラーの数           */
 Dsc_result_t               *Result
                         /* 検査結果             */
);

(c) 引数
●Item

データ項目情報構造体を格納するポインタを指定します。

注※
列挙型の値は,ヘッダファイル(Dsc_interface.h)中のコメントで確認できます。
●ErrIDList

エラーID配列へのポインタを受け取るエリアのポインタを指定します。

●ErrCount

エラーの数(ErrIDListに指定した配列の要素数)を受け取るエリアのポインタを指定します。

●Result

検査結果を受け取るエリアのポインタを指定します。

(d) 戻り値

DSC_OK :正常終了

DSC_ERROR:エラーが発生した

(e) 注意事項

(2) 業務ルールの検査関数

業務ルールの定義情報をチェックし,その結果をResultに返します。

(a) 関数名

DscCheckRule-業務ルールの定義情報チェック

(b) 形式

Dsc_status_t DscCheckRule(
 const Dsc_Rule_struct_t     *Rule,
                        /* 業務ルール情報構造体 */
 Dsc_err_id_t               **ErrIDList,
                        /* エラーID配列         */
 Dsc_int_t                   *ErrCount,
                        /* エラーの数            */
 Dsc_result_t                *Result
                        /* 検査結果              */
);

(c) 引数
●Rule

業務ルール情報構造体を格納するポインタを指定します。

注※
列挙型の値は,ヘッダファイル(Dsc_interface.h)中のコメントで確認できます。
●ErrIDList

エラーID配列へのポインタを受け取るエリアのポインタを指定します。

●ErrCount

エラーの数(ErrIDListに指定した配列の要素数)を受け取るエリアのポインタを指定します。

●Result

検査結果を受け取るエリアのポインタを指定します。

(d) 戻り値

DSC_OK:正常終了

DSC_ERROR:エラーが発生した

(e) 注意事項

(3) エラーIDからメッセージの取得関数

エラーIDからエラーメッセージを取得します。

指定されたエラーIDに対応するメッセージがない場合は,戻り値にDSC_ERRORを返します。

(a) 関数名

DscGetMessageFromErrID-エラーIDからメッセージを取得

(b) 形式

Dsc_status_t DscGetMessageFromErrID(
 Dsc_err_id_t    ErrID,     /* エラーID         */
 Dsc_char_t    **Message    /* エラーメッセージ */
);

(c) 引数
●ErrID

エラーIDを指定します。

●Message

エラーメッセージへのポインタを受け取るエリアのポインタを指定します。

(d) 戻り値

DSC_OK:正常終了

DSC_ERROR:エラーIDに対応にするメッセージがない

(4) エラーID領域の解放関数

引数ErrIDListで指定されたエラーID配列を破棄します。

(a) 関数名

DscFreeErrID-エラーID配列の破棄

(b) 形式

void DscFreeErrID(
 Dsc_err_id_t    *ErrIDList     /* エラーID配列 */
);

(c) 引数
●ErrIDList

削除するエラーID(検査関数で返されたエラーID)のポインタを指定します。

(d) 戻り値

戻り値はありません。