nn::cfg::CTR Namespace

Description

Namespace for the System Settings API.
(This namespace can also be written without the ::CTR portion.)

You must call nn::cfg::CTR::Initialize before any other function in the nn::cfg namespace that gets System Settings.

Classes

Result
nn::cfg::CTR::ResultOutOfMemory Insufficient memory.
nn::cfg::CTR::ResultNotFound Target cannot be found.
nn::cfg::CTR::ResultMountContentFailed Failed to mount content.

Structures

nn::cfg::CTR::UserName Structure that represents the user name.
nn::cfg::CTR::Birthday Structure that represents a birthday.
nn::cfg::CTR::SimpleAddress Structure that represents the user's simple address information configured in the System Settings.
nn::cfg::CTR::SimpleAddressId Structure that represents simple address information IDs.

Enumerated Types

CfgCoppacsRestriction Enumerated type representing COPPACS restrictions.
CfgCountryCode Enumerated type that represents country and area codes.
CfgLanguageCode Enumerated type that represents language codes.
CfgRegionCode Enumerated type that represents the region codes of system markets.
CfgSoundOutputMode Enumerated type that represents sound output modes.

Constants

CFG_PARENTAL_CONTROL_PIN_CODE_LENGTH const u8 The string length of the Parental Controls PIN.
CFG_USER_NAME_LENGTH const u8 The maximum string length of the user name. (Including the terminator.)
CFG_SIMPLE_ADDRESS_ID_COUNTRY_SHIFT const u8 Indicates the country code storage location in a SimpleAddress ID.
CFG_SIMPLE_ADDRESS_ID_REGION_SHIFT const u8 Indicates the region code storage location in a SimpleAddress ID.
CFG_SIMPLE_ADDRESS_ID_COUNTRY_MASK const u32 SimpleAddress ID for a country code mask.
CFG_SIMPLE_ADDRESS_ID_REGION_MASK const u32 Region code mask in a SimpleAddress.
CFG_SIMPLE_ADDRESS_ID_RESERVED_MASK const u32 SimpleAddress ID for a reserved region mask.
CFG_SIMPLE_ADDRESS_ID_NOT_DEFINED const u32 SimpleAddress undefined ID.
CFG_SIMPLE_ADDRESS_ID_COUNTRY_UNDEFINED const u32 SimpleAddress undefined country code.
CFG_SIMPLE_ADDRESS_ID_COUNTRY_UNDEFINED2 const u32 SimpleAddress undefined country code.
CFG_SIMPLE_ADDRESS_ID_REGION_UNDEFINED const u32 SimpleAddress undefined region code.
CFG_SIMPLE_ADDRESS_ID_REGION_UNDEFINED2 const u32 SimpleAddress undefined region code.
CFG_SIMPLE_ADDRESS_NUM_LANGUAGES const u8 The number of languages for country/region names in simple address information.
CFG_SIMPLE_ADDRESS_NAME_LENGTH const u8 The maximum length of country/region names in simple address information.
CFG_SIMPLE_ADDRESS_WORKMEMORY_SIZE const u32 The size of memory required to get simple address information.

Functions

Initialize Initializes the System Settings library.
Finalize Finalizes use of the System Settings library.
GetUserName Gets the user name.
GetBirthday Gets the birthday.
GetCountry Gets the country code.
GetCountryCodeA2 Converts the country code to ISO 3166-1 alpha-2 format. This API is fast because it returns the value in memory.
GetLanguage Gets the language code.
GetLanguageCodeA2 Converts a language code to ISO 639-1 alpha-2 format. This API is fast because it returns the value in memory.
GetSimpleAddress Gets the simple address information (such as the country and region name) that has been set by System Settings.
GetSimpleAddressId Gets only the ID from simple address information.
GetRegion Gets the region code of the system's market.
GetRegionCodeA3 Converts the region code of the system's market to the corresponding three-character string. This API is fast because it returns the value in memory.
GetSoundOutputMode Gets the sound output mode.
GetUserTimeOffset Gets RTC modification offset information.
IsCoppacsSupported Gets whether the current System Settings support COPPACS.
GetCoppacsRestriction Gets COPPACS restrictions.
CheckParentalControlPinCode Verifies the Parental Controls PIN code.
IsRestrictPhotoExchange Gets whether photo exchange is restricted by Parental Controls.
IsRestrictAddFriend Gets whether adding friends is restricted by Parental Controls.
IsRestrictP2pInternet Gets whether Internet communication with other users is restricted by Parental Controls.
IsRestrictP2pCec Gets whether StreetPass communication with other users is restricted by Parental Controls.
IsRestrictShopUse Gets whether use of the Nintendo eShop is restricted by Parental Controls.
IsAgreedEula Obtains whether the user has agreed to the EULA.
GetTransferableId Gets the system ID.

Revision History

2010/05/27
Initial version.

CONFIDENTIAL