CTRDG_IsOptionCartridge

Syntax

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

Arguments

None.

Return Values

Returns a value of TRUE if an Option Pak with peripherals is loaded; otherwise, 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, while the bus is locked, the ARM7 does not detect removal automatically, so call the CTRDG_IsExisting function at regular intervals, such as each game frame, during which the player cannot perform a re-insert operation. (This function internally calls the CTRDG_IsExisting function.)

See Also

CTRDG_Init, CTRDG_IsExisting, CTRDG_IsAgbCartridge

Revision History

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


CONFIDENTIAL