setlocale、_wsetlocale

[アーティクル]
06/09/2015

実行時ロケールを設定または取得します。

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

パラメーター

category
ロケールに影響されるカテゴリ。
locale
ロケールの指定子。

戻り値

有効な locale と category が指定された場合は、指定された locale と category に関連付けられている文字列へのポインターを返します。 locale または category が無効な場合、null ポインターを返します。プログラムの現在のロケール設定は変更されません。

たとえば、

setlocale( LC_ALL, "en-US" );

を呼び出すと、すべてのカテゴリを設定し、文字列だけを返します

en-US

setlocale によって返された文字列をコピーして、プログラムのロケール情報のその部分を復元できます。 setlocale によって返された文字列に対しては、グローバルまたはスレッドローカルストレージが使用されます。その後 setlocale を呼び出すと文字列が上書きされ、前の呼び出しで返された文字列のポインターは無効になります。

解説

locale および category で指定されている現在のプログラムのロケール情報の一部またはすべてを設定、変更、または照会するには、setlocale 関数を使用します。 locale とは、地域性、つまり国や地域、言語に関する情報であり、この情報に基づいてプログラムのさまざまな側面をカスタマイズできます。ロケールに依存するカテゴリとしては、日付の形式や通貨値の表示形式などがあります。 locale を、コンピューターでサポートされているさまざまな形式を持つ言語の既定の文字列に設定した場合は、setlocale 戻り値をチェックして、有効な言語を確認する必要があます。たとえば、locale を "chinese" に設定した場合、戻り値は "chinese-simplified" または "chinese-traditional" のいずれかです。

ワイド文字を扱う場合は、setlocale ではなく _wsetlocale を使用します。_wsetlocale の場合、locale 引数にはワイド文字列を指定します。また戻り値もワイド文字列です。それ以外では、_wsetlocale と setlocale の動作は同じです。

汎用テキストルーチンのマップ

TCHAR.H のルーチン	_UNICODE & _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tsetlocale	setlocale	setlocale	_wsetlocale

category 引数は、影響を受けるプログラムのロケール情報の部分を指定します。 category に使用するマクロ、および影響されるプログラムの一部は次のとおりです。

LC_ALL
次の一覧のすべてのカテゴリ。
LC_COLLATE
strcoll、_stricoll、wcscoll、_wcsicoll、strxfrm、_strncoll、_strnicoll、_wcsncoll、_wcsnicoll、および wcsxfrm の各関数。
LC_CTYPE
文字処理関数の (影響を受けない isdigit、isxdigit、mbstowcs、および mbtowc を除く)。
LC_MONETARY
localeconv 関数が返す通貨形式情報。
LC_NUMERIC
printf などの書式化出力ルーチン、データ変換ルーチン、および localeconv が返す通貨形式以外の形式情報で使用される小数点文字。小数点文字に加え、LC_NUMERIC は、桁区切り記号、および localeconv によって返されるグループ化コントロールの文字列も設定します。
LC_TIME
strftime および wcsftime 関数。

この関数は、カテゴリパラメーターを検証します。カテゴリパラメーターが前の表に示されている値のいずれでもない場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、この関数は errno を EINVAL に設定し、NULL を返します。

The locale 引数は、ロケールを指定する文字列へのポインターです。 locale 引数の書式の詳細については、「ロケール名、言語、および国/地域識別文字列」を参照してください。 locale が空の文字列をポイントしている場合は、実装定義のネイティブ環境になります。 C の値は、C 翻訳のための ANSI に準拠した最小環境を指定します。 C ロケールは、すべての char データ型が 1 バイトであり、それらの値は常に 256 未満であると推定します。

プログラムの開始時に、次のステートメントの等価性の確認が実行されます。

setlocale( LC_ALL, "C" );

locale 引数には、ロケール名、言語識別文字列、言語識別文字列と国/地域コード、コードページ、または言語識別文字列、国/地域コード、コードページを指定できます。使用できるロケール名、言語、国/地域コード、およびコードページのセットには、1 文字に 2 バイトを超えるデータを必要とする (UTF-7、UTF-8 など) コードページを除き、Windows の NLS API でサポートされるすべてが含まれています。 UTF-7 または UTF-8 のコードページ値を指定すると、setlocale は失敗し、NULL を返します。 setlocale でサポートされるロケール名のセットについては、「ロケール名、言語、および国/地域識別文字列」で説明します。 setlocale でサポートされる言語識別文字列と国/地域識別文字列は、「言語識別文字列」と「国/地域識別文字列」に記載されています。パフォーマンス上の理由と、コードに埋め込まれた、またはストレージに対してシリアル化されたロケール文字列の保守容易性の理由により、ロケール名形式を使用することをお勧めします。オペレーティングシステムの更新によってロケール名の文字列が変更される可能性は、言語および国/地域名の形式よりも低くなっています。

locale 引数として null ポインターを渡すことは、setlocale が国際的な環境を設定するのではなく、照会することを意味します。 locale 引数が null ポインターの場合、プログラムの現在のロケール設定は変更されません。代わりに、setlocale は、スレッドの現在のロケールの category に対応する文字列へのポインターを返します。 category 引数が LC_ALL の場合、関数は各カテゴリの現在の設定を表すセミコロンで区切られた文字列を返します。たとえば、呼び出しのシーケンス

// Set all categories and return "en-US"

setlocale(LC_ALL, "en-US");

// Set only the LC_MONETARY category and return "fr-FR"

setlocale(LC_MONETARY, "fr-FR");

printf("%s\n", setlocale(LC_ALL, NULL));

の場合、

LC_COLLATE=en-US;LC_CTYPE=en-US;LC_MONETARY=fr-FR;LC_NUMERIC=en-US;LC_TIME=en-US

は、LC_ALL カテゴリに対応する文字列です。

次の例は LC_ALL のカテゴリに関連するものです。文字列 ".OCP" および ".ACP" のどちらかをコードページ番号の代わりに使用して、それぞれの文字列で、ユーザー既定の OEM コードページおよびユーザー既定の ANSI コードページを使用することを指定できます。

setlocale( LC_ALL, "" );
ロケールを既定に設定します。これはオペレーティングシステムから取得したユーザー既定の ANSI コードページです。
setlocale( LC_ALL, ".OCP" );
ロケールに、オペレーティングシステムから取得した現在の OEM コードページを明示的に設定します。
setlocale( LC_ALL, ".ACP" );
ロケールに、オペレーティングシステムから取得した ANSI コードページを設定します。
setlocale( LC_ALL, "<localename>" );
ロケールに、<localename> で表されるロケール名を設定します。
setlocale( LC_ALL, "<language>_<country>" );
ロケールに、<language> と <country> で表される言語と国/地域、およびホストオペレーティングシステムから取得した既定のコードページを設定します。
setlocale( LC_ALL, "<language>_<country>.<code_page>" );
ロケールに、<language>、<country>、および <code_page> によって表される言語、国/地域、コードページを設定します。言語、国/地域、およびコードページはさまざまに組み合わせて使用できます。たとえば、次の呼び出しは、ロケールに、カナダフランス語、およびコードページ 1252 を設定します。

setlocale( LC_ALL, "French_Canada.1252" );

次の呼び出しは、ロケールに、カナダフランス語、および既定の ANSI コードページを設定します。

setlocale( LC_ALL, "French_Canada.ACP" );

次の呼び出しは、ロケールに、カナダフランス語、および既定の OEM コードページを設定します。

setlocale( LC_ALL, "French_Canada.OCP" );
setlocale( LC_ALL, "<language>" );
ロケールに <language> で表される言語を設定し、指定した言語の既定の国/地域と、その国/地域のユーザー既定の ANSI コードページをホストオペレーティングシステムから取得して使用します。たとえば、次の setlocale の呼び出しは同等です。

setlocale( LC_ALL, "en-US" );

setlocale( LC_ALL, "English" );

setlocale( LC_ALL, "English_United States.1252" );

パフォーマンスと保守性の理由から、最初の形式を使用することをお勧めします。
setlocale( LC_ALL, ".<code_page>" );
コードページに、<code_page> で表される値、および指定したコードページの既定の国/地域と言語 (ホストオペレーティングシステムによって定義) を設定します。

カテゴリは、コードページの変更に影響する LC_ALL または LC_CTYPE である必要があります。たとえば、ホストオペレーティングシステムの既定の国/地域と言語が "United States" と "English" の場合、次の setlocale の 2 種類の呼び出しは機能的に同じです。

setlocale( LC_ALL, ".1252" );

setlocale( LC_ALL, "English_United States.1252");

詳細については、「C/C++ プリプロセッサリファレンス」で紹介されている setlocale プラグマディレクティブを参照してください。

setlocale がプログラムのすべてのスレッドのロケールに影響するか、または呼び出し元のスレッドのロケールだけに影響するかどうかを制御するには、関数 _configthreadlocale を使用します。

必要条件

ルーチン	必須ヘッダー
setlocale	<locale.h>
_wsetlocale	<locale.h> または <wchar.h>

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

// crt_setlocale.c
// 
// This program demonstrates the use of setlocale when
// using two independent threads.
//

#include <locale.h>
#include <process.h>
#include <windows.h>
#include <stdio.h>
#include <time.h>

#define BUFF_SIZE 100

// Retrieve the date in the current
// locale's format.
int get_date(unsigned char* str)
{
    __time64_t ltime;
    struct tm  thetime;

    // Retrieve the current time
    _time64(&ltime);
    _gmtime64_s(&thetime, &ltime);

    // Format the current time structure into a string
    // "%#x" is the long date representation in the
    // current locale
    if (!strftime((char *)str, BUFF_SIZE, "%#x", 
                  (const struct tm *)&thetime))
    {
        printf("strftime failed!\n");
        return -1;
    }
    return 0;
}

// This thread sets its locale to the argument
// and prints the date.
uintptr_t __stdcall SecondThreadFunc( void* pArguments )
{
    unsigned char str[BUFF_SIZE];
    char * locale = (char *)pArguments;

    // Set the thread locale
    printf("The thread locale is now set to %s.\n",
           setlocale(LC_ALL, locale));

    // Retrieve the date string from the helper function
    if (get_date(str) == 0)
    {
        printf("The date in %s locale is: '%s'\n", locale, str);
    }

    _endthreadex( 0 );
    return 0;
} 

// The main thread sets the locale to English 
// and then spawns a second thread (above) and prints the date.
int main()
{ 
    HANDLE          hThread;
    unsigned        threadID;
    unsigned char   str[BUFF_SIZE];

    // Configure per-thread locale to cause all subsequently created 
    // threads to have their own locale.
    _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);

    // Set the locale of the main thread to US English.
    printf("The thread locale is now set to %s.\n",
           setlocale(LC_ALL, "en-US"));

    // Create the second thread with a German locale.
    // Our thread function takes an argument of the locale to use.
    hThread = (HANDLE)_beginthreadex( NULL, 0, &SecondThreadFunc,
                                      "de-DE", 0, &threadID );

    if (get_date(str) == 0)
    {
        // Retrieve the date string from the helper function
        printf("The date in en-US locale is: '%s'\n\n", str);
    }

    // Wait for the created thread to finish.
    WaitForSingleObject( hThread, INFINITE );

    // Destroy the thread object.
    CloseHandle( hThread );
}

同等の .NET Framework 関数

System::Globalization::CultureInfo Class

次の方法で共有

setlocale、_wsetlocale

パラメーター

戻り値

解説

必要条件

使用例

同等の .NET Framework 関数

参照

関連項目

その他のリソース