GetCalendarInfoW 関数 (winnls.h)
識別子で指定されたロケールの予定表に関する情報を取得します。
構文
int GetCalendarInfoW(
[in] LCID Locale,
[in] CALID Calendar,
[in] CALTYPE CalType,
[out, optional] LPWSTR lpCalData,
[in] int cchData,
[out, optional] LPDWORD lpValue
);
パラメーター
[in] Locale
予定表情報を取得するロケールを指定するロケール識別子。 MAKELCID マクロを使用してロケール識別子を作成するか、次のいずれかの定義済み値を使用できます。
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] Calendar
[in] CalType
取得する情報の種類。 詳細については、「予定表の 種類の情報」を参照してください。
CAL_NOUSEROVERRIDEの場合、関数は SetCalendarInfo によって設定された値を無視し、現在のシステムの既定のロケールのデータベース設定を使用します。 この型は、CAL_NOUSEROVERRIDEの組み合わせにのみ関連します。 |CAL_ITWODIGITYEARMAX。 CAL_ITWODIGITYEARMAXは、 SetCalendarInfo で設定できる唯一の値です。
[out, optional] lpCalData
この関数が要求されたデータを文字列として取得するバッファーへのポインター。 CAL_RETURN_NUMBERが CalType で指定されている場合、このパラメーターは NULL を取得する必要があります。
[in] cchData
lpCalData バッファーのサイズ (文字単位)。 アプリケーションでは、このパラメーターを 0 に設定して、カレンダー データ バッファーに必要なサイズを返すことができます。 この場合、 lpCalData パラメーターは使用されません。 CalType にCAL_RETURN_NUMBERを指定した場合、cchData の値は 0 である必要があります。
[out, optional] lpValue
要求されたデータを数値として受け取る変数へのポインター。 CAL_RETURN_NUMBERが CalType で指定されている場合、lpValue を NULL にすることはできません。 CAL_RETURN_NUMBERが CalType で指定されていない場合、lpValue は NULL である必要があります。
戻り値
成功した場合、cchData が 0 以外の値に設定された lpCalData バッファーで取得された文字数を返します。 関数が成功し、 cchData が 0 に設定され、CAL_RETURN_NUMBERが指定されていない場合、戻り値はカレンダー情報を保持するために必要なバッファーのサイズです。 関数が成功し、 cchData が 0 に設定され、CAL_RETURN_NUMBERが指定されている場合、戻り値は lpValue で取得された値のサイズです。つまり、関数の Unicode バージョンの場合は 2、ANSI バージョンの場合は 4 です。
成功しなかった場合、この関数は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。これにより、次のいずれかのエラー コードが返されます。
- ERROR_INSUFFICIENT_BUFFER。 指定されたバッファー サイズが十分に大きくなかったか、 正しく NULL に設定されていませんでした。
- ERROR_INVALID_FLAGS。 フラグに指定された値が無効でした。
- ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効です。
解説
注意
winnls.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetCalendarInfo を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winnls.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |