SCIGetCafeLanguage

Syntax

#include <cafe/sci.h>

SCIStatus SCIGetCafeLanguage(SCICafeLanguage *language);

Parameters

language Pointer to store language setting.

SCICafeLanguage

SCI_CAFE_LANGUAGE_JAPANESE Japanese
SCI_CAFE_LANGUAGE_ENGLISH English
SCI_CAFE_LANGUAGE_FRENCH French
SCI_CAFE_LANGUAGE_GERMAN German
SCI_CAFE_LANGUAGE_ITALIAN Italian
SCI_CAFE_LANGUAGE_SPANISH Spanish
SCI_CAFE_LANGUAGE_CHINESE Chinese
SCI_CAFE_LANGUAGE_KOREAN Korean
SCI_CAFE_LANGUAGE_DUTCH Dutch
SCI_CAFE_LANGUAGE_PORTUGUESE Portuguese
SCI_CAFE_LANGUAGE_RUSSIAN Russian
SCI_CAFE_LANGUAGE_TAIWANESE Taiwanese
SCI_CAFE_LANGUAGE_INVALID Invalid language setting is detected (Will not occur after SDK 2.12.00).

Return Values

SCI_STATUS_SUCCESS Successfully done.
SCI_STATUS_FAIL Failed to get value.
SCI_STATUS_READ_ERROR Error reading the system configuration file.
SCI_STATUS_FILE_NOT_FOUND System configuration file is not found.
SCI_STATUS_ITEM_NOT_FOUND Item is not found in the system configuration file.

Description

Gets the current language setting from the system configuration setting file.

Before SDK 2.12.00, SCIGetCafeLanguage returns SCI_CAFE_LANGUAGE_INVALID when an invalid language is set in the system settings. Since SDK 2.12.00, the language specified for each platform should return when that case. When using SDK 2.12.00 or later, it is not necessary to handle SCI_CAFE_LANGUAGE_INVALID.

Platform RegionSpecified Language
JapanJapanese
USEnglish
EuropeEnglish
ChinaChinese
KoreaKorean
TaiwanTaiwanese
OtherEnglish

NOTE:
Run System Config Tool at least once before using SCI. System Config Tool automatically creates the default system setting files at startup. If it has never run, this function returns a SCI_STATUS_FILE_NOT_FOUND error.

Do Not Call From

None.

See Also

System Config Tool
Region

Revision History

2014/07/01 Added information that it is no longer necessary to handle SCI_CAFE_LANGUAGE_INVALID SDK 2.12.00.
2013/05/08 Automated cleanup pass.
2013/01/23 Updates for System Config Tool
2012/04/30 Initial version.


CONFIDENTIAL