CARD_IdentifyBackup

C Specification

#include <nitro/card.h>

BOOL CARD_IdentifyBackup(CARDBackupType type);

Arguments

type The backup device type mounted on NITRO-CARD
CARD_BACKUP_TYPE_NOT_USE cannot be specified.

Return Values

TRUE if the process succeeds. FALSE otherwise.

Description

This function specifies the backup device that is mounted in a NITRO-CARD. The function identifies the device and test-reads the top byte. If the read is successful, it returns TRUE. If not, it returns FALSE. Detailed result values of CARDResult type indicating success or failure can be obtained with the CARD_GetResultCode function.
After this function is specified, CARD functions will work based on the assumption that the relevant device is mounted.
Do not access a device by specifying a device that is not actually mounted because it can cause the improper operation of the program and damage to the mounted device.


This function communicates with the ARM7 processor internally via PXI.
The process will not end if PXI interrupts are not enabled.

In NITRO-SDK 2.1 PR and later, card test-reading was added to this function's internal operation. In order to use this function, you must first lock the access bus with the CARD_LockBackup function.

See Also

CARDResult, CARDBackupType, CARD_GetBackupTotalSize, CARD_GetBackupSectorSize, CARD_GetCurrentBackupType

Revision History

06/20/2005 Added clear statement that CARD_BACKUP_TYPE_NOT_USE cannot be specified.
04/04/2005 Added statement and description about internal test read and necessity of access bus lock.
12/09/2004 Changed description from "IO Processor" to "ARM7 Processor."
09/10/2004 Added statement that specification of non-installed devices is strongly prohibited.
08/18/2004 Added statement about PXI interrupts.
07/05/2004 Initial version.