CriErr API


列挙型

enum  CriError {
  CRIERR_OK = 0, CRIERR_NG = -1, CRIERR_INVALID_PARAMETER = -2, CRIERR_FAILED_TO_ALLOCATE_MEMORY = -3,
  CRIERR_UNSAFE_FUNCTION_CALL = -4, CRIERR_FUNCTION_NOT_IMPLEMENTED = -5, CRIERR_LIBRARY_NOT_INITIALIZED = -6
}
 エラーコード [詳細]
enum  CriErrorNotificationLevel { CRIERR_NOTIFY_ALL = 0, CRIERR_NOTIFY_FATAL = 1 }
 エラー通知レベル [詳細]

関数

const CriChar8 *CRIAPI criErr_ConvertIdToMsg (const CriChar8 *errid)
 エラーID文字列からエラーメッセージへ変換
const CriChar8 *CRIAPI criErr_ConvertIdToMessage (const CriChar8 *errid, CriUint32 p1, CriUint32 p2)
 エラーID文字列からエラーメッセージへ変換
void CRIAPI criErr_SetCallback (CriErrCbFunc cbf)
 エラーコールバック関数の登録
void CRIAPI criErr_SetErrorNotificationLevel (CriErrorNotificationLevel level)
 エラー通知レベルの変更
CriUint32 CRIAPI criErr_GetErrorCount (CriErrorLevel level)
 エラー発生回数の取得
void CRIAPI criErr_ResetErrorCount (CriErrorLevel level)
 エラー発生回数のリセット

説明

エラーハンドリング用関数群

列挙型

enum CriError

エラーコード

列挙型の値:
CRIERR_OK  正常終了
CRIERR_NG  エラーが発生
CRIERR_INVALID_PARAMETER  引数が不正
CRIERR_FAILED_TO_ALLOCATE_MEMORY  メモリの確保に失敗
CRIERR_UNSAFE_FUNCTION_CALL  非スレッドセーフ関数の並列実行
CRIERR_FUNCTION_NOT_IMPLEMENTED  未実装関数の実行
CRIERR_LIBRARY_NOT_INITIALIZED  ライブラリが未初期化

enum CriErrorNotificationLevel

エラー通知レベル

列挙型の値:
CRIERR_NOTIFY_ALL  全てのエラーを通知
CRIERR_NOTIFY_FATAL  エラーのみ通知(警告は無視)


関数

const CriChar8* CRIAPI criErr_ConvertIdToMsg ( const CriChar8 *  errid  ) 

エラーID文字列からエラーメッセージへ変換

引数:
[in] errid エラーID文字列
戻り値:
エラーメッセージ
説明:
エラーID文字列から詳細なエラーメッセージへ変換します。
注意:
この関数は旧仕様の関数です。
代わりに criErr_ConvertIdToMessage 関数を使用してください。
参照:
criErr_ConvertIdToMessage

const CriChar8* CRIAPI criErr_ConvertIdToMessage ( const CriChar8 *  errid,
CriUint32  p1,
CriUint32  p2 
)

エラーID文字列からエラーメッセージへ変換

引数:
[in] errid エラーID文字列
[in] p1 補足情報1
[in] p2 補足情報2
戻り値:
エラーメッセージ
説明:
エラーID文字列から詳細なエラーメッセージへ変換します。
用例:
 void user_error_callback_func(const CriChar8 *errid, CriUint32 p1, CriUint32 p2, CriUint32 *parray);
 {
    const CriChar8 *errmsg;
    errmsg = criErr_ConvertIdToMessage(errid, p1, p2);
    printf("%s\n", errmsg);
 }

void CRIAPI criErr_SetCallback ( CriErrCbFunc  cbf  ) 

エラーコールバック関数の登録

引数:
[in] cbf エラーコールバック関数
戻り値:
なし
説明:
エラーコールバック関数を登録します。
登録された関数は、CRIミドルウエアライブラリ内でエラーが発生したときに呼び出されます。
用例:
 void user_error_callback_func(const CriChar8 *errid, CriUint32 p1, CriUint32 p2, CriUint32 *parray);
 {
    const CriChar8 *errmsg;
    errmsg = criErr_ConvertIdToMessage(errid, p1, p2);
    printf("%s\n", errmsg);
 }
 
 void main(int ac, char *av[])
 {
        :
    // エラーコールバックの登録
    criErr_SetCallback(user_error_callback_func);
        :
 }
注意:
同時に登録できるエラーコールバック関数は1つです。
登録後に再度本関数を呼び出した場合は現在の登録を上書きします。

エラーコールバックの上書きが発生した場合、上書きした側、された側双方に警告が返されます。
アプリケーションの正常な処理の流れとして、意図的にエラーコールバック関数の差し替えを行うケースがある場合には、 一旦「criErr_SetCallback(NULL);」を実行してコールバックの登録を解除し、 その後に改めてエラーコールバック関数の登録を行ってください。

void CRIAPI criErr_SetErrorNotificationLevel ( CriErrorNotificationLevel  level  ) 

エラー通知レベルの変更

引数:
[in] level エラー通知レベル
戻り値:
なし
説明:
エラーコールバックに通知するエラーのレベルを変更します。

CriUint32 CRIAPI criErr_GetErrorCount ( CriErrorLevel  level  ) 

エラー発生回数の取得

引数:
[in] level エラーレベル
戻り値:
エラー発生回数
説明:
エラー発生回数を取得します。

void CRIAPI criErr_ResetErrorCount ( CriErrorLevel  level  ) 

エラー発生回数のリセット

引数:
[in] level エラーレベル
戻り値:
なし
説明:
エラー発生回数のカウンタを0に戻します。


CRI Middleware logo Copyright (c) 2006-2018 CRI Middleware Co., Ltd.