CARD_IdentifyBackup

Syntax

#include <nitro/card.h>

BOOL CARD_IdentifyBackup(CARDBackupType type);

Arguments

type	The type of backup device that is mounted in a Game Card. You cannot specify CARD_BACKUP_TYPE_NOT_USE.

Return Values

Returns TRUE if a single byte was successfully read from the device. Returns FALSE if the Game Card has been removed or the Game Card is not making proper contact.

Description

Specifies the backup device that is mounted in a Game Card. The function identifies the device and test-reads the first byte. If the read is successful, it returns TRUE. If not, it returns FALSE. Detailed CARDResult-type result values relating to success or failure can be obtained with the CARD_GetResultCode function.

Note

• Once this function is used to specify a device, CARD functions will run under the assumption that the relevant device is actually 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's return value can confirm that there is poor contact with a Game Card, but it cannot confirm whether the mounted device is of the correct type. Note that even when the return value is TRUE, it is possible for a different device to actually be mounted.
• This function communicates with the ARM7 processor internally via PXI. The process will not end if PXI interrupts are not enabled.
• To use this function, you must lock the access bus beforehand with the CARD_LockBackup function.

See Also

CARDResult, CARDBackupType, CARD_GetBackupTotalSize, CARD_GetBackupSectorSize, CARD_GetCurrentBackupType

Revision History

2008/09/06 Added a note stating that the return value cannot be used to confirm the mounted device.
2005/06/20 Added a clear statement that CARD_BACKUP_TYPE_NOT_USE cannot be specified.
2005/04/05 Added a statement and description about internal test reads and the necessity of locking the access bus.
2004/12/09 Changed descriptions from "IO Processor" to "ARM7 Processor."
2004/09/10 Added a statement that it is strongly prohibited to specify devices that are not mounted.
2004/08/18 Added a statement about PXI interrupts.
2004/07/05 Initial version.

CONFIDENTIAL