CARD_GetResultCode

Syntax

#include <nitro/card.h>

CARDResult CARD_GetResultCode( void );

Arguments

None.

Return Values

Returns the result of the last process run by the function that accesses the CARD ROM device and the backup device.

Description

This function returns the result of the last process that is run by the function that accesses the CARD ROM device and the backup device. From the result value that is obtained with this function, the success or failure of the process and the detailed cause of the failure can be determined.
This function allows these functions to obtain the result value. However, the functions that are shown in green will always have a return value of CARD_RESULT_SUCCESS; therefore, it is not necessary to explicitly determine the value of the result.

These functions access the backup device:

  [EEPROM]
  CARD_ReadEeprom 
  CARD_ReadEepromAsync 
  CARD_WriteEeprom 
  CARD_WriteEepromAsync 
  CARD_VerifyEeprom 
  CARD_VerifyEepromAsync 
  CARD_WriteAndVerifyEeprom 
  CARD_WriteAndVerifyEepromAsync

  [FLASH]
  CARD_ReadFlash 
  CARD_ReadFlashAsync 
  CARD_WriteFlash 
  CARD_WriteFlashAsync 
  CARD_VerifyFlash 
  CARD_VerifyFlashAsync 
  CARD_WriteAndVerifyFlash 
  CARD_WriteAndVerifyFlashAsync 

  [Common]
  CARD_IdentifyBackup
  CARD_LockBackup
  CARD_UnlockBackup

These functions access the ROM device:

  CARD_LockRom 
  CARD_UnlockRom 
  CARD_ReadRom 
  CARD_ReadRomAsync 
Of the functions mentioned above, the result value of the last called function is the return value for this function. These return values do not change if functions other than the above mentioned CARD functions are called.

See Also

CARDResult, CARD_ReadRom, CARD_ReadEeprom, CARD_WriteEeprom, CARD_VerifyEeprom, CARD_WriteAndVerifyEeprom

Revision History

2004/11/02 Corrected an error in writing.
2004/08/31 Corrected most of the function description, and added description regarding the function that updates the result value.
2004/07/28 Initial version.


CONFIDENTIAL