CARDResult

定義

#include <nitro/card.h>

typedef enum
{
CARD_RESULT_SUCCESS = 0,
CARD_RESULT_FAILURE,
CARD_RESULT_INVALID_PARAM,
CARD_RESULT_UNSUPPORTED,
CARD_RESULT_TIMEOUT,
CARD_RESULT_ERROR,
CARD_RESULT_NO_RESPONSE,
CARD_RESULT_CANCELED
} CARDResult;


説明

CARD ROM デバイスおよびバックアップデバイスへアクセスする関数の処理結果を表す列挙定数を示します。
各値の意味は以下の通りです。
意味
CARD_RESULT_SUCCESS 関数の処理が、正しく完了したことを表します。
また、CARD_Verify*( ) のように処理の結果が真理値で得られる場合の「真」を表します。
CARD_RESULT_FAILURE 関数の処理が、予想される範囲内において失敗したことを表します。
これは、CARD_Verify*( ) のように処理の結果が真理値で得られる場合の「偽」を表します。
CARD_RESULT_INVALID_PARAM 関数に与えられた引数が異常なために処理が行われなかったことを表します。
CARD_RESULT_UNSUPPORTED 現在CARD_IdentifyBackup( ) で特定されているデバイスに搭載されていない
機能を使用した関数のため、処理が行われなかったことを表します。
これは、デバイスタイプを指定していないかCARD_BACKUP_TYPE_NOT_USEを指定した場合に発生します。
CARD_RESULT_TIMEOUT 待ち時間を伴う関数が規定の時間を越えて中止されたことを表します。
これは、搭載デバイスの寿命または故障によって発生する場合があります。
待ち時間を伴う全ての関数は内部で充分な回数の再試行を行いますので、
この返り値を受けてユーザアプリケーション側で改めて再試行する必要はありません。
CARD_RESULT_NO_RESPONSE 搭載デバイスが状態応答すら返さないために処理が失敗したことを表します。
これは、NITRO-CARDと本体の間での接触不良かまたは搭載デバイスの故障によって発生する場合があります。
CARD_RESULT_CANCELED 待ち時間を伴う関数の処理がCARD_CancelBackupAsync( )によって中止されたことを表します。
CARD_RESULT_ERROR 上記いずれにも該当しないその他の異常で処理が失敗したことを表します。

参照

CARD_IdentifyBackup, CARD_GetResultCode, CARD_ReadRom, CARD_ReadEeprom, CARD_WriteEeprom, CARD_VerifyEeprom, CARD_WriteAndVerifyEeprom, CARD_CancelBackupAsync

履歴

2005/09/02 CARD_RESULT_NO_RESPONSEおよびCARD_RESULT_CANCELEDを追加
2005/04/05 CARD_RESULT_TIMEOUTの説明にCARD自体の接触不良についての記述を追加
2004/08/23 ライブラリ内部で再試行する旨の説明を追加
2004/07/28 初版