GetTimeFormatA 関数 (datetimeapi.h)
識別子で指定されたロケールの時刻文字列として時刻を書式設定します。 この関数は、指定した時刻またはローカル システム時刻を書式設定します。
構文
int GetTimeFormatA(
[in] LCID Locale,
[in] DWORD dwFlags,
[in, optional] const SYSTEMTIME *lpTime,
[in, optional] LPCSTR lpFormat,
[out, optional] LPSTR lpTimeStr,
[in] int cchTime
);
パラメーター
[in] Locale
ロケールを指定するロケール識別子。 MAKELCID マクロを使用してロケール識別子を作成するか、次のいずれかの定義済み値を使用できます。
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] dwFlags
時刻形式オプションを指定するフラグ。 詳細な定義については、getTimeFormatExの
[in, optional] lpTime
書式設定する時刻情報を含む SYSTEMTIME 構造体へのポインター。 この関数が現在のローカル システム時刻を使用する場合、アプリケーションはこのパラメーターを NULL を
[in, optional] lpFormat
時刻文字列の書式設定に使用する書式図へのポインター。 アプリケーションでこのパラメーターを NULL
[out, optional] lpTimeStr
この関数が書式設定された時刻文字列を取得するバッファーへのポインター。
[in] cchTime
lpTimeStrで示される時間文字列バッファーのサイズ (TCHAR 値)。 または、アプリケーションでこのパラメーターを 0 に設定することもできます。 この場合、この関数は時刻文字列バッファーに必要なサイズを返し、lpTimeStr パラメーターを使用しません。
戻り値
lpTimeStrによって示されるバッファーで取得された TCHAR 値
成功しなかった場合、この関数は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError
- ERROR_INSUFFICIENT_BUFFER。 指定されたバッファー サイズが十分な大きさではなかったか、NULL
正しく設定されていません。 - ERROR_INVALID_FLAGS。 フラグに指定された値が無効でした。
- ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効でした。
- ERROR_OUTOFMEMORY。 この操作を完了するのに十分な記憶域が使用できませんでした。
備考
GetTimeFormatExの
この関数の ANSI バージョンを Unicode のみのロケール識別子と共に使用すると、オペレーティング システムがシステム コード ページを使用するため、関数は成功する可能性があります。 ただし、システム コード ページで未定義の文字は、文字列に疑問符 (?) として表示されます。
手記
datetimeapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetTimeFormat を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされる最小サーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | datetimeapi.h |
| ライブラリ | Kernel32.lib |
| DLL | Kernel32.dll |
関連項目
GetDateFormat を
GetLocaleInfo の
GetTimeFormatEx の