Declare Function GetTimeFormat Lib "kernel32" Alias "GetTimeFormatA" _
         (Locale As Long, _
          dwFlags As DWord, _
    ByRef lpTime As SYSTEMTIME,_
          lpFormat As BytePtr, _
          lpTimeStr As BytePtr, _
          cchTime As Long) As Long

dwFlags
オプション フラグを、以下の定数を組み合わせて指定します。不要なときは 0 を指定します。

定数	説明
LOCALE_NOUSEROVERRIDE	指定したロケールが持つシステムのデフォルトの時刻フォーマットにしたがって、時刻をフォーマットします。lpFormat パラメータが NULL のときに有効です。
TIME_NOMINUTESORSECONDS	分または秒は使用しません。
TIME_NOSECONDS	秒は使用しません。
TIME_NOTIMEMARKER	時刻マーカーは使用しません。
TIME_FORCE24HOURFORMAT	24 時間制を使用します。

lpTime （ポインタ参照）
システム タイムが格納されている、SYSTEMTIME構造体へのポインタを指定します。NULL を指定すると、現在のローカル システム タイムが使用されます。

lpFormat
dwFlags パラメータが 0 のときに、書式文字列を指定します。それ以外は NULL を指定します。書式文字列は、以下の文字列から成り立ちます。書式文字列以外の文字列は、シングルクォーテーション「'」（Chr$(39)）で囲むことをお勧めします。

書式文字列	説明
h	12 時間制の時間。先頭に 0 は付きません。
hh	12 時間制の時間。必要に応じて、先頭に 0 が付きます。
H	24 時間制の時間。先頭に 0 は付きません。
HH	24 時間制の時間。必要に応じて、先頭に 0 が付きます。
m	分。先頭に 0 は付きません。
mm	分。必要に応じて、先頭に 0 が付きます。
s	秒。先頭に 0 は付きません。
ss	秒。必要に応じて、先頭に 0 が付きます。
t	時刻マーカー。「 A 」「 P 」など。
tt	時刻マーカー。「 AM 」「 PM 」「午前」「午後」など。

lpTimeStr
フォーマットされた文字列を格納するためのバッファへのポインタを指定します。

cchTime
lpTimeStr パラメータで指定したバッファのバイト数を指定します。0 を指定すると、フォーマットは行われず、関数は必要なバイト数を返します。

戻り値

関数が成功すると、lpTimeStr パラメータで指定したバッファに書き込まれた文字列のバイト数が返ります。cchTime パラメータに 0 を指定したときは、必要なバイト数が返ります。関数が失敗すると、0 が返ります。

環境情報

インクルード ファイル: api_system.sbp 内で定義済み
DLLファイル: kernel32.dll