setlocale(3C)

構文

#include <locale.h>

char *setlocale(int category, const char *locale);

struct locale_data *getlocale(int type);

説明

setlocale() 関数は、category 引き数で指定されたプログラムの locale のアスペクトに対して設定、問合わせ、復旧を行います。プログラムの locale は、以下の category の値で定義されている、プログラムの母国語サポート (NLS) 環境の領域を参照します。

すべての nl_langinfo(3C) の項目は、上記のカテゴリのうちの １ つを設定すると作用します。 各項目に対してどのカテゴリが作用するかについては、 langinfo(5) を参照してください。

locale 引き数の値は setlocale() の動作を決定します。 locale は文字列型へのポインターです。

setlocale() は複数のスレッドから同時に呼び出すことができます。アップデートされた locale データ構造体は、別のスレッドからの読み取りに対して保護されていません。 そのため、locale 変更時の適切な同期処理は、アプリケーション作成者に一任されています。

戻り値

locale として文字列へのポインターが与えられ、その選択が認められる場合には、setlocale() 関数は指定された category に結合している文字列へのポインターを新しい locale として返します。この文字列の最大の長さは、LC_BUFSIZ (<locale.h> を参照) です。選択が認められない場合には、setlocale() 関数は、null ポインターを返し、プログラムの locale は変更されません。

locale に対する null ポインターにより、setlocale() はプログラムの現在の locale の category に結合している文字列を返します。

setlocale() によって返される文字列は、 setlocale() を再度呼び出すときに、 locale 引き数として用いられ、それに結合している category が、プログラムの locale のその部分を復旧します。

エラー

locale 引き数の指定する言語名が適切な言語を指さなかったり、言語名が 256 文字を超えていたり、あるいは言語がそのシステムでは利用できない場合 (lang(5) を参照) には、null ポインターが返され、プログラムの locale は変更されません。同じことは、以下のような呼び出しを行い、ユーザーの環境の中の環境変数に結合しているカテゴリが、不適切な言語名であるかシステムで利用できない言語を指している時にも起こります。

category 引き数が定義されているカテゴリの値でない場合には、null ポインターが返され、プログラムの locale は変更されません。

setlocale() は category 引き数に結合している NLS 環境のアスペクトの現在の 設定を反映している文字列を返します。返された文字列は、それ以降の setlocale() の呼び出しで用いられ、２ つの呼び出しにおいて category 引き数が一致しない場合には、locale は変更されず、null ポインターが返されます。

例

以下の例は、ユーザーの環境変数で指定された言語の要求をもとにプログラムのすべての locale を設定します。

ユーザーの環境変数が以下のように設定されている場合を例にします。

LC_CTYPE, LC_MONETARY, および LC_NUMERIC カテゴリ項目は、de_DE.iso88591 の言語定義に結合するように設定され、LC_COLLATE カテゴリ項目は、es_ES.iso88591 の言語定義に結合するよう設定され、LC_TIME カテゴリ項目は en_US.iso88591 の言語定義に結合するよう設定されます。

同じ例を用いて、以下のような呼び出しが行われるとします。

この時、*locale_info の内容は以下のようになります。

次の例では、LC_ALL 環境変数の優先を示します。

ユーザー環境が以下のように設定されているとします。

この時、すべてのカテゴリが fr_FR.iso88591 に設定されます。

LC_ALL 環境変数の優先例をもう １ つ示します。

ユーザー環境が以下のように設定されているとします。

この時、すべてのカテゴリが da_DK.iso88591 でロードされます。

LC_ALL 環境変数の例をもう １ つ示します。

ユーザー環境が以下のように設定されているとします。

LC_TIME カテゴリは、pl_PL.iso88592 に設定されます。しかし、他のすべてのカテゴリは nl_NL.iso88591 に設定されます。

以下の例は、日付/時刻の書式を fr_FR.iso88591 に設定します。

以下の例は、照合順序を C locale に設定します。

以下の例は、一時ハンドリングを、ユーザーの LC_MONETARY 環境変数の値に設定します。

LC_MONETARY 環境変数が設定されていなかったり、空の文字列である場合には、ユーザーの LANG 環境変数が用いられることに注意してください。

以下の例は、ユーザーの locale を問い合わせます。

上記の例で保存された locale を復旧するには、次のようにします。

以下の例は、 LC_NUMERIC カテゴリに属しているユーザー locale の部分のみを問い合わせます。

上記の例で保存されたユーザーの locale の LC_NUMERIC カテゴリのみを復旧するには次のようにします。

警告

setlocale() のリターン文字列のフォーマットは処理系に固有のもので、各ベンダーのプラットフォームで標準化されたものではありません。また、将来リリースされる製品で変更される可能性があります。リターン文字列は、setlocale() を実行するプロセスが実行されている間のみ有効で、すでに保存されているロケールの設定を同じプロセスで再び使用する場合のみに使用します。

getenv() の locale は、引き数として使用しない方がよいでしょう。以下にその誤った使用法を示します。

getenv() は、言語名, 空の文字列, null ポインターの文字列を、ユーザーの LANG 環境変数の設定に応じて返します。locale 引き数としてのそれらの値は、setlocale() によって行われる特定の動作を定義しています。したがって、setlocale() によって行われる動作は、getenv() の呼び出しから返される値に依存します。setlocale() がプログラムの locale をユーザーの環境変数の設定に従って設定しないようにするには、以下の使い方がよいでしょう。

setlocale() によって返される値は、次の setlocale() の呼び出しの間にオーバーライトされる領域を指しています。それらの値を次の setlocale() の呼び出し以降で使用する場合には、それらを他の領域にコピー するようにしてください。

setlocale() の呼び出しは、HP-UX 10.0 でサポートが中止された、HP-UX 9.x での古い HP 独自のロケール名の使用をサポートしていません。新しい ISO のロケール名 (リリースノートに記載) を使用してください。

getlocale() は、HP 独自のインタフェースで、将来リリースされる製品では廃止 される予定です。 また、この関数は、他のベンダーのプラトフォームへ移植することはできません。

getlocale() の呼び出しによって返される構造体は、次の getlocale() 呼び出しの間にオーバーライトされます。それらの値を次以降の getlocale() 呼び出しで用いる場合には、それらを保存するようにしてください。

locale の状態はプロセス内のすべてのスレッドで共通であることに注意してください。

getlocale_r() および setlocale_r() インタフェースは廃止され、現在では既存の DCE アプリケーションとの互換性を保つためにだけサポートされています。新しいマルチスレッドアプリケーションでは、 getlocale() および setlocale() を使用してください。

現リリースでは、LC_MESSAGES が XPG4 に追加されているため、oflag パラメータが NL_CAT_LOCALE に設定された状態で、catopen() より前で setlocale() を呼び出すプログラムはすべて、以前のリリースとは異なった動作をすることがあります。以前は catopen() が LANG によって、希望の言語を指定するようになっていました。現在は、oflag パラメータが NL_CAT_LOCALE に設定された catopen() の制御は LC_MESSAGES で行います。 setlocale() は LC_MESSAGES カテゴリを変更することができます。 たとえば、環境変数が以下のように設定されているとします。

ここで、catopen() を呼び出した後で 以下のように setlocale() を呼び出します。

catopen() により、fr_FR.iso88591 ではなく de_DE.iso88591 に対するメッセージカタログがオープンされます。

setlocale() を使用してアプリケーションのアーカイブをコンパイルまたはリンクする場合は、setlocale() は libdld.sl と依存関係があり、 コンパイルまたはリンク用のコマンドを変更しなければならない ことに注意してください。

コンパイルする場合は、以下のように指定します。

または、

CCOPTS および LDOPTS を使用し、以下のように指定してコンパイルします。

オプションの -Wl,-a,archive は部分的に依存関係があり、コンパイルを指定するコマンド行の最初で指定します。将来リリースされる製品との優れた互換性を保つためには、アーカイブされた libc を他の共有ライブラリとともに使用しないでください。ただし、上記の場合に必要な libdld.sl は例外とします。

著者

setlocale()、setlocale_r()、getlocale()、および getlocale_r() は OSF および HP で開発されました。

ファイル

/usr/include/langinfo.h
/usr/include/locale.h

参照

locale(1), localedef(1M), conv(3C), ctype(3C), ecvt(3C), getdate(3C), multibyte(3C), nl_langinfo(3C), regcomp(3C), string(3C), perror(3C), strfmon(3C), strftime(3C), string(3C), strptime(3C), strtod(3C), wcsftime(3C), wcstring(3C), printf(3S), scanf(3S), vprintf(3S), wconv(3C), wctype(3C), wcstod(3C), wcstol(3C), environ(5), lang(5), langinfo(5), thread_safety(5)

標準準拠

setlocale(): AES, SVID3, XPG3, XPG4, FIPS 151-2, POSIX.1, ANSI C