dcngettext(3C)

名前 | 形式 | 機能説明 | 戻り値 | 使用法 | ファイル | 属性 | 関連項目

名前

gettext, dgettext, dcgettext, ngettext, dngettext, dcngettext, textdomain, bindtextdomain, bind_textdomain_codeset– メッセージ処理関数

形式

Solaris および GNU 互換

#include <libintl.h>

char *gettext(const char *msgid);
char *dgettext(const char *domainname, const char *msgid);
char *textdomain(const char *domainname);
char *bindtextdomain(const char *domainname, const char *dirname);


#include <libintl.h> 
#include <locale.h>

char *dcgettext(const char *domainname, const char *msgid, int category);


GNU 互換

#include <libintl.h>

char *ngettext(const char *msgid1, const char *msgid2, unsigned long int n);
char *dngettext(const char *domainname, const char *msgid1, const char *msgid2, unsigned long int n);
char *bind_textdomain_codeset(const char *domainname, const char *codeset);


#include <libintl.h> 
#include <locale.h>

char *dcngettext(const char *domainname, const char *msgid1, const char *msgid2, unsigned long int n, int category);

機能説明

gettext()、dgettext()、dcgettext() 関数は、特定のドメイン内において、また、現在のロケールにおいて、指定の msgid 引数に基づいたターゲット文字列を取得します。gettext()、dgettext()、dcgettext() から返される文字列の長さは、これらの関数が呼び出されるまでは未定です。msgid 引数は、NULL で終わる文字列です。

ngettext()、dngettext()、および dcngettext() 関数はそれぞれ、gettext()、dgettext()、および dcgettext() と同等ですが、GNU 互換メッセージカタログだけを処理することができ、複数形の処理方法が異なります。メッセージ文字列を検索するとき、ngettext()、dngettext()、および dcngettext() 関数は msgid1 引数を検索鍵として使用し、n 引数で複数形を決定します。メッセージカタログが見つからない場合、n == 1 であれば msgid1 が返され、そうでなければ msgid2 が返されます。

環境変数 NLSPATH (environ(5) を参照) が、最初に LC_MESSAGES カタログの位置として検索されます。現在のロケールの LC_MESSAGES カテゴリの設定によって、gettext() および dgettext() が文字列取得に使用するロケールが決まります。category 引数は dcgettext() の使用するロケールを決めます。NLSPATH が定義されておらず、現在のロケールが C ロケールの場合、gettext()、gettext()、dcgettext() は、渡されたメッセージ文字列をそのまま返します。C 以外のロケールでは、NLSPATH が定義されていない場合、あるいは、NLSPATH で指定したコンポーネントでメッセージカタログが見つからない場合、メッセージカタログの検索には、次の段落で説明するスキームが使用されます。

LANGUAGE 環境変数は、使用する GNU 互換メッセージカタログを決定するために調べられます。LANGUAGE の値はコロン (:) で区切られたロケール名のリストです。LANGUAGE が定義されている場合、リストに指定されている順番で各ロケールが検索されます。そして、GNU 互換メッセージカタログが見つかった場合、そのメッセージが返されます。GNU 互換メッセージが見つかったが、対応する msgid が見つからない場合、msgid 文字列が返されます。LANGUAGE が定義されていない場合、あるいは、LANGUAGE の処理中に Solaris メッセージカタログが見つかったが GNU 互換メッセージカタログが見つからない場合、dirname/locale/category/domainname .mo というパス名でメッセージカタログが検索されます。ここで、dirname は bindtextdomain() で指定されたディレクトリ、locale はロケール名、category は LC_MESSAGES または LC_XXX のどちらかです。LC_MESSAGES は gettext()、dgettext()、ngettext()、または dngettext() を呼び出した場合に使用されます。LC_XXX は dcgettext() または dcngettext() を呼び出した場合に使用され、XXX 部分は category 引数で指定したロケールカテゴリ名と同じになります。

gettext() と ngettext() の場合、使用されるドメインは、最後に行なった textdomain() の有効な呼び出しによって設定されます。textdomain() の有効な呼び出しが行われていない場合は、デフォルト時のドメイン (messages) が使用されます。

dgettext()、dngettext() 、dcngettext()、および dcgettext() の場合、使用されるドメインは domainname 引数で指定されます。この domainname 引数は、構文と意味において、textdomain() の domainname 引数と同等ですが、このドメインの選択が dgettext()、dcgettext()、dngettext() および dcngettext() 関数の呼び出し中にのみ有効であるという点で異なります。

textdomain() 関数は、アクティブな LC_MESSAGES ロケールカテゴリの現在のドメイン名の設定 または照会を行います。domainname 引数は、正当なファイル名に使用できる文字のみからなる、NULL で終わる文字列です。

domainname 引数は、システム内の、一意のドメイン名です。1 つのシステム内に、同一ドメインのバージョンが 複数存在する場合は、bindtextdomain() を使用して名前空間の衝突を回避することができます。textdomain() を呼び出さない場合には、デフォルト時のドメインが選択されます。最後に行なった textdomain() の有効な呼び出しによるドメインの設定は、このあとに行う setlocale(3C) および gettext() の呼び出しにおいても有効です。

domainname 引数は、現在アクティブな、LC_MESSAGES ロケールに適用されます。

domainname に NULL ポインタを設定して textdomain() を呼び出すことによって、ドメインの現在の状態に影響することなく、ドメインの現在の設定を照会することができます。domainname 引数に NULL 文字列を設定して textdomain() を呼び出すと、ドメインの設定は、デフォルト時のドメイン (messages) になります。

bindtextdomain() 関数は、メッセージドメインのパス部分 domainname と、dirname に入っている値を結合します。domainname が空文字列ではなく、まだ結合されていない場合には、bindtextdomain() は、domainname と dirname を結合します。

domainname が空文字列ではなく、すでに結合されている場合には、bindtextdomain() は、事前に行われていた結合部分を dirname に置き換えます。dirname 引数に使用できるのは、gettext()、dgettext()、または dcgettext() が呼び出されたときに解決される、絶対パス名または相対パス名です。domainname が NULL ポインタまたは空文字列の場合は、bindtextdomain() は NULL を返します。ユーザー定義のドメイン名は、SYS_ で始めることはできません。この文字列で始まるドメイン名は、システムで使用するために予約されています。

bind_textdomain_codeset() 関数を使用すると、ドメイン domainname のメッセージカタログ用の出力コードセットを指定できます。codeset 引数は、iconv_open(3C) 関数に対して使用可能な有効なコードセット名であるか、空ポインタである必要があります。codeset 引数が 空ポインタの場合、bind_textdomain_codeset() はドメイン domainname 用に現在選択されているコードセットを返します。コードセットが選択されていない場合、bind_textdomain_codeset() は 空ポインタを返します。bind_textdomain_codeset() 関数は複数回使用できます。同じ domainname 引数を指定して bind_textdomain_codeset() 関数を複数回使用した場合、先行する呼び出しで行われた設定は後続の呼び出しによって無効にされます。bind_textdomain_codeset() 関数は、選択されたコードセット名を含む文字列へのポインタを返します。この文字列は bind_textdomain_codeset() 関数に内部的に割り当てられているため、ユーザーが変更してはなりません。

戻り値

gettext()、dgettext()、および dcgettext() 関数は、検索が成功した場合、メッセージ文字列を返します。検索が失敗した場合、msgid 文字列を返します。

ngettext()、dngettext()、および dcngettext() 関数は、検索が成功した場合、メッセージ文字列を返します。検索が失敗した場合、n == 1 であれば、msgid1 を返します。そうでなければ、msgid2 を返します。

gettext()、dgettext()、 dcgettext() ngettext()、dngettext()、dcngettext() が返す文字列の個々のバイトには、空文字以外のあらゆる値が入ります。msgid が NULL ポインタである場合の戻り値は未定義です。返される文字列は、プログラムで修正してはならず、この後で gettext()、dgettext()、dcgettext()、ngettext()、dngettext()、dcngettext() または setlocale(3C) を呼び出すことにより、無効になることがあります。dgettext()、dcgettext()、dngettext()、または dcngettext() に対する domainname 引数が NULL ポインタである場合、現在 textdomain() によってバインドされているドメインが使用されます。

textdomain() の正常な戻り値は、ドメインの現在の設定が入っている文字列へのポインタです。domainname が NULL ポインタの場合は、textdomain() は現在のドメインが入っている文字列へのポインタを返します。textdomain() を先に呼び出していない場合に domainname を 空文字列にすると、デフォルト時のドメイン名が返されます。デフォルト時のドメイン名は、messages です。textdomain() が失敗した場合、NULL ポインタが返されます。

bindtextdomain() からの戻り値は、dirname が入った NULL で終わる文字列です。dirname が NULL. の場合は、domainname と結び付けられたディレクトリバインディングです。何も結合されていない場合には、デフォルトの戻り値は /usr/lib/locale になります。domainname が NULL ポインタまたは空文字列の場合、bindtextdomain() は何も行わず、NULL ポインタを返します。返された文字列を呼び出し側で変更してはなりません。bindtextdomain() が失敗した場合、NULL ポインタが返されます。

使用法

これらのルーチンでは、メッセージの長さに制限はありません。ただし、テキスト domainname は、TEXTDOMAINMAX (256) バイト以内に制限されています。

ロケール変更のために setlocale(3C) が呼び出されていない限り、マルチスレッドアプリケーションにおいて gettext()、dgettext()、dcgettext()、ngettext()、dngettext()、 dcngettext()、textdomain()、および bindtextdomain() 関数を安全に使うことができます。

gettext()、dgettext()、dcgettext()、textdomain()、および bindtextdomain() 関数は Solaris メッセージカタログと GNU 互換メッセージカタログの両方を処理できます。ngettext()、dngettext()、dcngettext()、および bind_textdomain_codeset() 関数は GNU 互換メッセージカタログだけを処理できます。Solaris メッセージカタログと GNU 互換メッセージカタログの詳細については、msgfmt(1) のマニュアルページを参照してください。

ファイル

/usr/lib/locale

メッセージ・ドメイン・ファイルのデフォルトパス部分

/usr/lib/locale/locale/LC_MESSAGES/domainname.mo

言語 locale および domainname 用メッセージの入っているファイルのシステムデフォルト位置

/usr/lib/locale/locale/LC_XXX/domainname.mo

LC_XXX が LC_CTYPE、LC_NUMERIC、LC_TIME、LC_COLLATE、LC_MONETARY、または LC_MESSAGES である場合に、dcgettext() 呼び出し用の言語 locale および domainname メッセージの入っているファイルのシステムデフォルト位置

dirname/locale/LC_MESSAGES/domainname.mo

bindtextdomain() の正常な呼び出し後の、ドメイン domainname およびパス部分 dirname 用メッセージが入っているファイルの位置

dirname/locale/LC_XXX/domainname.mo

bindtextdomain() の正常な呼び出し後の LC_XXX が、LC_CTYPE、LC_NUMERIC、LC_TIME、LC_COLLATE、LC_MONETARY、または LC_MESSAGES のいずれかである場合 dcgettext() 呼び出し用のドメイン domainname、言語 locale、およびパス部分 dirname メッセージが入っているファイルの位置

属性

次の属性については attributes(5) のマニュアルページを参照してください。

属性タイプ	属性値
MT レベル	例外付き MT-Safe

関連項目

msgfmt(1), xgettext(1), iconv_open(3C), setlocale(3C), attributes(5), environ(5)

SunOS 5.10  最終更新日 2002年2月1日

名前 | 形式 | 機能説明 | 戻り値 | 使用法 | ファイル | 属性 | 関連項目