CTRDG_IsOptionCartridge

C Specification

#include <nitro/ctrdg.h>
BOOL IsOptionCartridge( void );
  

Arguments

None.

Return Values

Returns a value of TRUE if an Option Pak with peripherals is loaded. Otherwise it returns a value of FALSE. Also, always returns FALSE after the Game Pak has been removed once.

Description

This function returns a BOOLEAN value to indicate if an Option Pak with peripherals is installed.

However, this function will always return a value of FALSE after it detects the initial removal of an Option Pak. (This behavior is not limited to the Option Pak.) This function can be called when the cartridge bus is locked with the OS_LockCartridge function. However, when the bus is locked, the ARM7 will not perform automatic release detection processing, and thus you should periodically call CTRDG_IsExisting each game frame or other interval when the player cannot reinsert. (This function internally calls CTRDG_IsExisting.)

See Also

CTRDG_Init, CTRDG_IsExisting, CTRDG_IsAgbCartridge

Revision History

04/12/2005 Added description of cartridge bus lock
09/17/2004 Initial version