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

<この項の構成>
(1) 条件情報取得関数
(2) チェック関数

(1) 条件情報取得関数

条件名,条件の値の型および値の初期値を返します。

(a) 関数名

NrlGetConditionInfo

(b) 形式

Nrl_status_t NrlGetConditionInfo(
   Nrl_char_t**              ConditionName,
                              /* 条件名          */
   Nrl_value_type_t*         ValueType,
                              /* 値の型          */
   Nrl_init_value_struct_t*  InitValueList
                              /* 条件の値の初期値*/
);

(c) 引数

ConditionName:条件名(出力引数)

ValueType:条件の値の型(出力引数)

InitValueList:条件の値の初期値(出力引数)

(d) 戻り値

NRL_OK:正常終了

NRL_ERROR:異常終了

(2) チェック関数

定義されている名称(文字列)が,条件にあっているかどうかをチェックします。

(a) 関数名

NrlCheckName

(b) 形式

Nrl_status_t NrlCheckName(
   const Nrl_char_t*       Name,
                        /* チェック対象の文字列 */
   const void*             Value,
                        /* 値                   */
   Nrl_result_t*           Result
                        /* チェック結果         */
);

(c) 引数

Name:チェック対象の文字列(入力引数)

Value:値(入力引数)

Result:チェック結果(出力引数)

(d) 戻り値

NRL_OK:正常終了

NRL_ERROR:異常終了