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 によって設定された値
[out, optional] lpCalData
この関数が要求されたデータを文字列として取得するバッファーへのポインター。 CalTypeでCAL_RETURN_NUMBER
[in] cchData
lpCalData バッファーのサイズ (文字単位)。 アプリケーションでは、このパラメーターを 0 に設定して、カレンダー データ バッファーに必要なサイズを返すことができます。 この場合、lpCalData パラメーターは使用されません。
[out, optional] lpValue
要求されたデータを数値として受け取る変数へのポインター。 CalTypeでCAL_RETURN_NUMBER
戻り値
成功した場合、lpCalData バッファーで取得 cchData 0 以外の値に設定された文字数を返します。 関数が成功 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 を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされる最小サーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | winnls.h (Windows.h を含む) |
| ライブラリ | Kernel32.lib |
| DLL | Kernel32.dll |
関連項目
予定表の種類情報 を
GetCalendarInfoEx の
SetCalendarInfo の