トップ 一覧 検索 ヘルプ RSS ログイン

Palm OS Programmer's API Reference/41の変更点

  • 追加された行はこのように表示されます。
  • 削除された行はこのように表示されます。
[[← 40 章に戻る|Palm OS Programmer's API Reference/40]] [[↑トップへ|Palm OS Programmer's API Reference]] [[42 章に進む →|Palm OS Programmer's API Reference/42]]
----

{{anchor top}}

この章の索引

*{{goto Locale Manager Data Types,ロケール マネージャ データ タイプ}}
**{{goto CountryType,CountryType}}
**{{goto LanguageType,LanguageType}}
**{{goto LmLocaleType,LmLocaleType}}
**{{goto NumberFormatType,NumberFormatType}}
*{{goto Locale Manager Constants,ロケール マネージャ定数}}
**{{goto Character Encoding Constants,文字エンコード定数}}
**{{goto Country Constants,カントリー定数}}
**{{goto Language Constants,言語定数}}
**{{goto Locale Manager Size Constants,ロケール マネージャ サイズ定数}}
*{{goto Locale Manager Functions,ロケール マネージャ関数}}
**{{goto LmGetLocaleSetting,LmGetLocaleSetting}}
**{{goto LmGetNumLocales,LmGetNumLocales}}
**{{goto LmLocaleToIndex,LmLocaleToIndex}}

----

!!!41 ロケール マネージャ

この章では、ヘッダファイル {{span style='color:blue;font-family:monospace;',LocaleMgr.h, Localize.h, PalmLocale.h}} で定義されているロケール マネージャ API について説明します。以下の内容について説明します。

*{{goto Locale Manager Data Types,ロケール マネージャ データ タイプ}}
*{{goto Locale Manager Constants,ロケール マネージャ定数}}
*{{goto Locale Manager Functions,ロケール マネージャ関数}}

ロケール マネージャについての更なる情報は、''Palm OS Programmer's Companion, vol. I'' の[[「アプリケーションのローカライズ」|Palm OS Programmer's Companion Volume I/12]]を参照してください。


!!{{anchor Locale Manager Data Types}}ロケール マネージャ データ タイプ {{goto top,^TOP^}}

!{{anchor CountryType}}CountryType Typedef {{goto top,^TOP^}}

'''目的'''

{{span style='color:blue;font-family:monospace;',CountryType}} はカントリー コードを定義します。{{span style='color:blue;font-family:monospace;',PalmLocale.h}} の中の{{goto Country Constants,カントリー定数}}が {{span style='color:blue;font-family:monospace;',CountryType}} 変数のためのとり得る値を定義しています。

'''Prototype'''

 typedef UInt8 CountryType;

'''互換性'''

バージョン 4.0 より前では、{{span style='color:blue;font-family:monospace;',CountryType}} は 33ヶ国のみを定義していた {{span style='color:blue;font-family:monospace;',Preference.h}} の中の列挙体でした。{{span style='color:blue;font-family:monospace;',CountryType}} の Palm OS 4.0 定義はそれ以前の定義と互換性があります。


!{{anchor LanguageType}}LanguageType Typedef {{goto top,^TOP^}}

'''目的'''

{{span style='color:blue;font-family:monospace;',LanguageType}} は言語コードを定義します。{{span style='color:blue;font-family:monospace;',PalmLocale.h}} の中の{{goto Language Constants,言語定数}}は {{span style='color:blue;font-family:monospace;',LanguageType}} 変数のためにとり得る値を定義しています。

'''Prototype'''

 typedef UInt8 LanguageType;

'''互換性'''

{{span style='color:blue;font-family:monospace;',LanguageType}} 定義は Palm OS 3.5 で追加されました。バージョン 4.0 より前では、{{span style='color:blue;font-family:monospace;',LanguageType}} は 8 つのみの言語コードを定義していた {{span style='color:blue;font-family:monospace;',Preference.h}} の中の列挙体でした。{{span style='color:blue;font-family:monospace;',LanguageType}} の Palm OS 4.0 定義はそれ以前の定義と互換性があります。


!{{anchor LmLocaleType}}LmLocaleType 構造体 {{goto top,^TOP^}}

'''目的'''

{{span style='color:blue;font-family:monospace;',LmLocaleType}} 構造体はロケールの中で使用されるカントリーと言語を定義します。

'''Prototype'''

 struct _LmLocaleType {
 	UInt16 language;
 	UInt16 country;
 };
 
 typedef struct _LmLocaleType LmLocaleType;

'''フィールド'''

*{{span style='color:blue;font-family:monospace;',language}}
**{{goto Language Constants,言語定数}}の 1 つです。この値は現在のロケールの中で話されている言語を指定します。
*{{span style='color:blue;font-family:monospace;',country}}
**{{goto Country Constants,カントリー定数}}の 1 つです。この値は方言を指定する助けとなるロケールのカントリーを指定します。例えば、{{span style='color:blue;font-family:monospace;',lEnglish}} の言語は、カントリーが {{span style='color:blue;font-family:monospace;',cUnitedKingdom}} の場合と {{span style='color:blue;font-family:monospace;',cUnitedStates}} の場合では、異なる方言を指定します。

{{span style='color:blue;font-family:monospace;',language}} と {{span style='color:blue;font-family:monospace;',country}} フィールドは、{{span style='color:blue;font-family:monospace;',LanguageType}} と {{span style='color:blue;font-family:monospace;',CountryType}} のである代わりに、{{span style='color:blue;font-family:monospace;',UInt16}} 型であることに注意してください。

'''互換性'''

{{span style='color:blue;font-family:monospace;',LmLocaleType}} は、{{goto 4.0 New Feature Set,4.0 New Feature Set|Palm OS Programmer's API Reference/B}} が満たされる場合にのみ、定義されます。それは Palm OS 3.5 で導入された {{span style='color:blue;font-family:monospace;',OmLocaleType}} を抑制し、{{span style='color:blue;font-family:monospace;',LmLocaleType}} は {{span style='color:blue;font-family:monospace;',OmLocaleType}} とビット-互換性があります。


!{{anchor NumberFormatType}}NumberFormatType 列挙体 {{goto top,^TOP^}}

'''目的'''

{{span style='color:blue;font-family:monospace;',NumberFormatType}} 列挙体は、数がどのようにフォーマットされるのかを指定します。{{span style='color:blue;font-family:monospace;',NumberFormatType}} 値を {{goto LocGetNumberSeparators,LocGetNumberSeparators()|Palm OS Programmer's API Reference/60}} に渡すことができ、千ごとと小数のための適切な区切り文字を受け取ることができます。

'''Prototype'''

 typedef enum {
 	nfCommaPeriod,
 	nfPeriodComma,
 	nfSpaceComma,
 	nfApostrophePeriod,
 	nfApostropheComma
 } NumberFormatType;

'''定数'''

*{{span style='color:blue;font-family:monospace;',nfCommaPeriod}}
**千ごとの区切りとしてカンマ(,)を、小数の区切りとしてピリオド(.)を使用します。
*{{span style='color:blue;font-family:monospace;',nfPeriodComma}}
**千ごとの区切りとしてピリオド(.)を、小数の区切りとしてカンマ(,)を使用します。
*{{span style='color:blue;font-family:monospace;',nfSpaceComma}}
**千ごとの区切りとしてスペース( )を、小数の区切りとしてカンマ(,)を使用します。
*{{span style='color:blue;font-family:monospace;',nfApostrophPeriod}}
**千ごとの区切りとしてアポストロフィ(')を、小数の区切りとしてピリオド(.)を使用します。
*{{span style='color:blue;font-family:monospace;',nfApostrophComma}}
**千ごとの区切りとしてアポストロフィ(')を、小数の区切りとしてカンマ(,)を使用します。


!!{{anchor Locale Manager Constants}}ロケール マネージャ定数 {{goto top,^TOP^}}


!{{anchor Character Encoding Constants}}文字エンコード定数 {{goto top,^TOP^}}

{{span style='color:blue;font-family:monospace;',PalmLocal.h}} ファイルは、{{goto CharEncodingType,CharEncodingType|Palm OS Programmer's API Reference/55}} 変数の値として使用される、いくつかの文字エンコード定数を定義します。文字エンコード定数は一般に以下のフォーマットに従います:

----
{{span style='color:blue;font-family:monospace;',charEncoding}}{{span style='color:blue;font-family:monospace;font-style:italic;',Name}}
----

''Name'' には、文字エンコードの名前が入ります。

以下の表は文字エンコード定数の例を示してます。完全なリストは、{{span style='color:blue;font-family:monospace;',PalmLocale.h}} ファイルを参照してください。

,定数,説明
,"{{span style='color:blue;font-family:monospace;',charEncodingUnknown}}",Palm OS のこのバージョンでは未知です。
,"{{span style='color:blue;font-family:monospace;',charEncodingAscii}}",ISO 646-1991
,"{{span style='color:blue;font-family:monospace;',charEncodingISO8859_1}}",ISO 8859 パート 1(ISO ラテン 1 としても知られています)。このエンコードは一般にローマ字のために使用されます。
,"{{span style='color:blue;font-family:monospace;',charEncodingPalmLatin}}",Microsoft Windows コード ページ 1252 の Palm OS バージョンです。このエンコードは、Palm 指定文字がコントロール レンジに追加された状態で、コード ページ 1252 と等価です。
,"{{span style='color:blue;font-family:monospace;',charEncodingShiftJIS}}",シングル-バイト片仮名(訳者注: 半角かな文字)を持つ 0208-1990 のためのエンコードです。このエンコードは一般に日本語のアルファベットのために使用されます。
,"{{span style='color:blue;font-family:monospace;',charEncodingPalmSJIS}}",Microsoft Windows コード ページ 932 の Palm OS バージョンです。このエンコードは、Palm 指定文字がコントロール レンジに追加され、円シンボルがロケーション 0x5c の逆スラッシュ文字の代わりにある状態で、コード ページ 932 と等価です。
,"{{span style='color:blue;font-family:monospace;',charEncodingCP1252}}",Microsoft Windows の ISO 8859 パート 1 への拡張です。
,"{{span style='color:blue;font-family:monospace;',charEncodingCP932}}",Microsoft Windows の Shift JIS  への拡張です。
,"{{span style='color:blue;font-family:monospace;',charEncodingUTF8}}",Unicode のための 8-ビットの安全なエンコードです。


!{{anchor Country Constants}}カントリー定数 {{goto top,^TOP^}}

{{span style='color:blue;font-family:monospace;',PalmLocale.h}} ファイルは、{{goto CountryType,CountryType}} 変数の値として使用される、いくつかのカントリー定数を定義します。カントリー タイプ定数は以下のフォーマットに従います:

----
{{span style='color:blue;font-family:monospace;',c}}{{span style='color:blue;font-family:monospace;font-style:italic;',CountryName}}
----

''CountryName'' にはカントリーの名前が入ります。現在のところ 239 のカントリーを定義している ISO 3166 標準の中で識別される各カントリーのための 1 つの定数があります。

以下の表は、カントリー タイプ定数の例を示しています。完全なリストは、{{span style='color:blue;font-family:monospace;',PalmLocale.h}} ファイルを参照してください。

,定数,説明
,"{{span style='color:blue;font-family:monospace;',cAustralia}}",オーストラリア
,"{{span style='color:blue;font-family:monospace;',cAustria}}",オーストリア
,"{{span style='color:blue;font-family:monospace;',cBelgium}}",ベルギー


!{{anchor Language Constants}}言語定数 {{goto top,^TOP^}}

{{span style='color:blue;font-family:monospace;',PalmLocale.h}} ファイルは、{{goto LanguageType,LanguageType}} 変数の値として使用される、いくつかの言語定数を定義します。言語タイプ定数は以下のフォーマットに従います:

----
{{span style='color:blue;font-family:monospace;',l}}{{span style='color:blue;font-family:monospace;font-style:italic;',LanguageName}}
----

''LanguageName'' には言語の名前が入ります。現在のところ 137 の言語を定義している ISO 639 標準の中で識別される各言語のための 1 つの定数があります。

以下の表は、言語タイプ定数の例を示しています。完全なリストは、{{span style='color:blue;font-family:monospace;',PalmLocale.h}} ファイルを参照してください。

,定数,説明
,"{{span style='color:blue;font-family:monospace;',lEnglish}}",英語
,"{{span style='color:blue;font-family:monospace;',lFrench}}",フランス語
,"{{span style='color:blue;font-family:monospace;',lGerman}}",ドイツ語


!{{anchor Local Manager Size Constants}}ロケール マネージャ サイズ定数 {{goto top,^TOP^}}

ロケール マネージャ サイズ定数を、あるロケール設定のために割り当てられる文字列のサイズを決定するために、使用することができます。

----
'''NOTE:''' 以下の表の中の定数は終端 null 文字をカウントしていません。それゆえ、例えばカントリー命を保持するにはサイズ {{span style='color:blue;font-family:monospace;',kMaxCountryNameLen+1}} の文字列を割り当てる必要があります。
----

,定数,値,説明
,"{{span style='color:blue;font-family:monospace;',kMaxCountryNameLen}}",19,カントリー名文字列の最大長
,"{{span style='color:blue;font-family:monospace;',kMaxCurrencyNameLen}}",19,通貨名文字列の最大長
,"{{span style='color:blue;font-family:monospace;',kMaxCurrencySymbolNameLen}}",5,通貨シンボル文字列の最大長


!!{{anchor Locale Manager Functions}}ロケール マネージャ関数 {{goto top,^TOP^}}


!{{anchor LmGetLocaleSetting}}LmGetLocaleSetting 関数 {{goto top,^TOP^}}

'''目的'''

与えられたロケールのために要求される設定を返します。

'''宣言されている場所'''

{{span style='color:blue;font-family:monospace;',LocaleMgr.h}}

'''Prototype'''

 Err LmGetLocaleSetting (
 	UInt16 iLocaleIndex,
 	LmLocaleSettingChoice iChoice,
 	void *oValue,
 	UInt16 iValueSize
 )

'''パラメータ'''

*{{span style='color:blue;font-family:monospace;',→ iLocaleIndex}}
**ロケールのインデックス。このロケールの設定を取得します。
*{{span style='color:blue;font-family:monospace;',→ iChoice}}
**取得したい設定。これは {{span style='color:blue;font-family:monospace;',lmChoice...}} の形をした定数の 1 つです。とり得る値のリストは、{{goto Table 41.1,表 41.1}} を参照してください。
*{{span style='color:blue;font-family:monospace;',← oValue}}
**{{span style='color:blue;font-family:monospace;',iChoice}} 設定の値。{{goto Table 41.1,表 41.1}} で示すように、このバッファのサイズは {{span style='color:blue;font-family:monospace;',iChoice}} の値に依存します。
*{{span style='color:blue;font-family:monospace;',→ iValueSize}}
**{{span style='color:blue;font-family:monospace;',oValue}} バッファのサイズ。

'''返り値'''

以下の値の 1 つを返します。

*{{span style='color:blue;font-family:monospace;',errNone}}
**成功
*{{span style='color:blue;font-family:monospace;',lmErrBadLocaleIndex}}
**{{span style='color:blue;font-family:monospace;',iLocaleIndex}} は範囲外です。
*{{span style='color:blue;font-family:monospace;',lmErrSettingDataOverflow}}
**{{span style='color:blue;font-family:monospace;',oValue}} バッファは、設定の値を保持するには小さすぎます。
*{{span style='color:blue;font-family:monospace;',lmErrBadLocaleSettingChoice}}
**{{span style='color:blue;font-family:monospace;',iChoice}} パラメータは未知またはサポートされない値を保持しています。

'''コメント'''

この関数はプライベート ロケール システム リソースにアクセスして、{{span style='color:blue;font-family:monospace;',oValue}} パラメータの中に要求された情報を返します。{{span style='color:blue;font-family:monospace;',oValue}} パラメータのサイズとタイプは取得したい設定に依存します。{{goto Table 41.1,表 41.1}} は、とり得る設定と各設定に対して {{span style='color:blue;font-family:monospace;',oValue}} で返されるデータのタイプをリストして説明しています。固定サイズの値に対しては、{{span style='color:blue;font-family:monospace;',oValue}} バッファのサイズが正確に返り値のサイズであることを確認しくください。そのサイズを返り値のサイズよりも大きくも小さくもすべきではありません。

この関数はロケールのデフォルトの設定を返します。ユーザは多くのロケールの設定を設定アプリケーションを使ってオーバライドすることができます。アプリケーションは、常にロケールのデフォルトよりもユーザの設定のほうを尊重すべきです。このため、対応するシステム設定が利用可能な場合は、そちらのほうをチェックすることが推奨されます({{goto PrefGetPreference,PrefGetPreference()|Palm OS Programmer's API Reference/48}} を使って)。ユーザがオーバライドできない値(カントリー名や通貨のシンボルなど)を取得する場合、または、現在のロケールではなく他のロケールについての情報を取得する場合にのみ、{{span style='color:blue;font-family:monospace;',LmGetLocaleSetting}} を使用してください。

{{anchor Table 41.1}}
'''表 41.1 LmGetLocaleSetting の選択とサイズ'''

,lmChoice...,oValue データ タイプ,説明
,"{{span style='color:blue;font-family:monospace;',CountryName}}","サイズ {{span style='color:blue;font-family:monospace;',kMaxCountryNameLen+1}} バイトの文字列バッファ",ロケールのカントリーの名前
,"{{span style='color:blue;font-family:monospace;',CurrencyName}}","サイズ {{span style='color:blue;font-family:monospace;',kMaxCurrencyNameLen+1}} バイトの文字列バッファ",このロケールで使用される通貨の名前
,"{{span style='color:blue;font-family:monospace;',CurrencySymbol}}","サイズ {{span style='color:blue;font-family:monospace;',kMaxCurrencySymbolLen+1}} バイトの文字列バッファ",このロケールの貨幣の値を示すために使用されるシンボル
,"{{span style='color:blue;font-family:monospace;',CurrencyDecimalPalces}}","{{span style='color:blue;font-family:monospace;',UInt16}}",通常、貨幣の値が与えられる十進数の桁数
,"{{span style='color:blue;font-family:monospace;',DateFormat}}","{{goto DateFormatType,DateFormatType|Palm OS Programmer's API Reference/57}}",このロケールで使用されるショート日付フォーマット。例えば:{{br}}95/12/31
,"{{span style='color:blue;font-family:monospace;',InboundDefaultVObjectEncoding}}","{{span style='color:blue;font-family:monospace;',CharEncodingType}}",CHARSET プロパティを持たない vObject のためのインバウンド エンコード(原文: inbound encoding)
,"{{span style='color:blue;font-family:monospace;',Locale}}","{{goto LmLocaleType,LmLocaleType}}",ロケールの言語とカントリー コードを保持している構造体
,"{{span style='color:blue;font-family:monospace;',LongDateFormat}}","{{goto DateFormatType,DateFormatType|Palm OS Programmer's API Reference/57}}",このロケールで使用されるロング日付フォーマット。例えば:{{br}}31 Dec 1995
,"{{span style='color:blue;font-family:monospace;',NumberFormat}}","{{goto NumberFormatType,NumberFormatType}}",このロケールの千ごとの区切り文字と小数点に関係を持つ数のために使用されるフォーマット
,"{{span style='color:blue;font-family:monospace;',OutboundVObjectEncoding}}","{{span style='color:blue;font-family:monospace;',CharEncodingType}}",vObject のためのアウトバウンド エンコード
,"{{span style='color:blue;font-family:monospace;',PrimaryEmailEncoding}}","{{span style='color:blue;font-family:monospace;',CharEncodingType}}",Email で最初に試みられるエンコード
,"{{span style='color:blue;font-family:monospace;',PrimarySMSEncoding}}","{{span style='color:blue;font-family:monospace;',CharEncodingType}}",SMS で最初に試みられるエンコード
,"{{span style='color:blue;font-family:monospace;',SecondaryEmailEncoding}}","{{span style='color:blue;font-family:monospace;',CharEncodingType}}",Email で 2 番目に試みられるエンコード
,"{{span style='color:blue;font-family:monospace;',SecondarySMSEncoding}}","{{span style='color:blue;font-family:monospace;',CharEncodingType}}",SMS で 2 番目に試みられるエンコード
,"{{span style='color:blue;font-family:monospace;',SupportsLunarCalendar}}","{{span style='color:blue;font-family:monospace;',Boolean}}",ロケールは中国の陰暦をサポートするか?
,"{{span style='color:blue;font-family:monospace;',TimeFormat}}","{{goto TimeFormatType,TimeFormatType|Palm OS Programmer's API Reference/58}}",このロケールでの時間の値のために使用されるフォーマット
,"{{span style='color:blue;font-family:monospace;',UniqueCurrencySymbol}}","サイズ {{span style='color:blue;font-family:monospace;',kMaxCurrencySymbolLen+1}} バイトの文字列バッファ","貨幣の値のための固有のシンボル{{br}}例えば、シンボル {{span style='color:blue;font-family:monospace;',$}} は US ドルとポルトガルのエスクードの両方で使用されます。US ドルの固有の貨幣シンボルは {{span style='color:blue;font-family:monospace;',US$}} です。"
,"{{span style='color:blue;font-family:monospace;',WeekStartDay}}","{{span style='color:blue;font-family:monospace;',UInt16}}",このロケールでの週の最初の曜日(日曜日または月曜日)。週の曜日は日曜日 = 0 から始まる 0 から 6 までの番号を付けられます。

'''互換性'''

{{goto 4.0 New Feature Set,4.0 New Feature Set|Palm OS Programmer's API Reference/B}} が満たされる場合にのみ、実装されます。より前のバージョンの Palm OS で実行されることを意図したコードの中でこの関数を使用するには、PalmOSGlue ライブラリにリンクをはり、{{span style='color:blue;font-family:monospace;',LmGlueGetLocaleSetting}} を呼び出します。更なる情報は、[[第 80 章 「Palm OSGlue ライブラリ」|Palm OS Programmer's API Reference/80]]を参照してください。

'''参照'''

{{goto LmGetNumLocales,LmGetNumLocales()}}, {{goto LmLocaleToIndex,LmLocaleToIndex()}}


!{{anchor LmGetNumLocales}}LmGetNumLocales 関数 {{goto top,^TOP^}}

'''目的'''

既知のロケールの数を返します。

'''宣言されている場所'''

{{span style='color:blue;font-family:monospace;',LocaleMgr.h}}

'''Prototype'''

 UInt16 LmGetNumLocales (
    void
 )

'''パラメータ'''

ありません。

'''返り値'''

システム リソースが定義するロケールの数を返します。

'''コメント'''

この関数を、{{goto LmGetLocaleSetting,LmGetLocaleSetting()}} に渡すことができるインデックスの値のとり得る範囲を取得するために、使用します。{{span style='color:blue;font-family:monospace;',LmGetNumLocales}} が 3 を返す場合、{{span style='color:blue;font-family:monospace;',LmGetLocaleSetting}} は 0 から 2 の範囲のインデックスを受け付けます。

この関数は ROM が持っているロケール情報のロケール数のみを返します。定義される可能性のあるロケールの数を返すわけではありません。例えば、システム リソースが現在のところ、言語が {{span style='color:blue;font-family:monospace;',lHebrew}} でカントリーが {{span style='color:blue;font-family:monospace;',cIsrael}} のロケール、それは有効なロケールではありますが、を保持していません。

'''互換性'''

{{goto 4.0 New Feature Set,4.0 New Feature Set|Palm OS Programmer's API Reference/B}} が満たされる場合にのみ、実装されます。より前のバージョンの Palm OS で実行されることを意図したコードの中でこの関数を使用するには、PalmOSGlue ライブラリにリンクをはり、{{span style='color:blue;font-family:monospace;',LmGlueGetNumLocales}} を呼び出します。更なる情報は、[[第 80 章 「Palm OSGlue ライブラリ」|Palm OS Programmer's API Reference/80]]を参照してください。


!{{anchor LmLocaleToIndex}}LmLocaleToIndex 関数 {{goto top,^TOP^}}

'''目的'''

{{goto LmLocaleType,LmLocaleType}} をインデックスに変換します。

'''宣言されている場所'''

{{span style='color:blue;font-family:monospace;',LocaleMgr.h}}

'''Prototype'''

 Err LmLocaleToIndex (
 	const LmLocaleType *iLocale,
 	UInt16 *oLocaleIndex
 )

'''パラメータ'''

*{{span style='color:blue;font-family:monospace;',→ iLocale}}
**変換するロケール
*{{span style='color:blue;font-family:monospace;',← oLocaleIndex}}
**返り時の {{span style='color:blue;font-family:monospace;',iLocale}} のインデックス

'''返り値'''

成功時には {{span style='color:blue;font-family:monospace;',errNone}} を返します。ロケールを見つけることができなかった場合は、{{span style='color:blue;font-family:monospace;',lmErrUnknownLocale}} を返します。

'''コメント'''

この関数を、{{goto LmGetLocaleSetting,LmGetLocaleSetting()}} に渡す有効なインデックスことができるインデックスの値を取得するために、使用します。例えば、現在のシステムで使用されているロケールを取得するためにオーバレイ マネージャ ルーチン {{goto OmGetSystemLocale,OmGetSystemLocale()|Palm OS Programmer's API Reference/44}} を使用し、それから、そのロケールのインデックスを取得するためにそのロケールをこの関数に渡すことがあるかもしれません。

 LmLocaleType locale;
 Char oValue[kMaxCurrencySymbolLen+1];
 UInt16 index;
  
 OmGetSystemLocale(&locale);
 LmLocaleToIndex(&locale, &index);
 LmGetLocaleSetting(index,
   lmChoiceCurrencySymbol, oValue,
   sizeof(oValue));

{{span style='color:blue;font-family:monospace;',iLocale}} に渡される {{span style='color:blue;font-family:monospace;',LmLocaleType}} にはワイルドカードとして {{span style='color:blue;font-family:monospace;',lmAnyCountry}} または {{span style='color:blue;font-family:monospace;',lmAnyLanguage}} を使用することができます。例えば、カントリーが {{span style='color:blue;font-family:monospace;',lmAnyCount}} である場合、{{span style='color:blue;font-family:monospace;',LmLocaleIndex}} はその言語に一致する最初のロケールのインデックスを返します。

'''互換性'''

{{goto 4.0 New Feature Set,4.0 New Feature Set|Palm OS Programmer's API Reference/B}} が満たされる場合にのみ、実装されます。より前のバージョンの Palm OS で実行されることを意図したコードの中でこの関数を使用するには、PalmOSGlue ライブラリにリンクをはり、{{span style='color:blue;font-family:monospace;',LmGlueLocaleToIndex}} を呼び出します。更なる情報は、[[第 80 章 「Palm OSGlue ライブラリ」|Palm OS Programmer's API Reference/80]]を参照してください。

----
[[← 40 章に戻る|Palm OS Programmer's API Reference/40]] [[↑トップへ|Palm OS Programmer's API Reference]] [[42 章に進む →|Palm OS Programmer's API Reference/42]]