FormatTime 関数

説明

ユーザーが指定した時刻、時刻形式、およびロケールに基づいて文字列式を返す式デザイナの関数。

構文

local variable = FormatTime(Time, Format, Locale)

FormatTime 関数の構文のパラメータは以下のとおりです。

Time
指定されたロケールに有効な時刻文字列または時刻文字列が含まれる変数。 現在のシステムの時刻を指定するには、「Current」を使用します。 時刻文字列を指定するには、希望する時刻文字列を引用符で囲んで入力します（例："01:12:23"）。 時刻文字列が含まれる変数の場合は、引用符なしで変数名を使用します。
Format
指定したロケールに対して有効な以下の要素の組み合わせで構成される時刻形式。
時間
  • h：時間を 12 時間形式で表し、時間が 1 桁の場合は先頭にゼロを付けません。
  • H：時間を 24 時間形式で表し、時間が 1 桁の場合は先頭にゼロを付けません。
  • hh：時間を 12 時間形式で表し、時間が 1 桁の場合は先頭にゼロを付けます。
  • HH：時間を 24 時間形式で表し、時間が 1 桁の場合は先頭にゼロを付けます。
分
  • m：分を表し、分が 1 桁の場合は先頭にゼロを付けません。
  • mm：分を表し、分が 1 桁の場合は先頭にゼロを付けます。
秒
  • s：秒を表し、秒が 1 桁の場合は先頭にゼロを付けません。
  • ss：秒を表し、秒が 1 桁の場合は先頭にゼロを付けます。
時刻マーカー
  • t：1 文字の時刻マーカー文字列（A または P など）。
  • tt：午前と午後を複数文字の文字列で表します（AM、PM など）。
Locale

一般的に、Locale には、ユーザーが自分のユーザー インターフェイスに表示するためのユーザーの言語や国、日付と時刻に使用する形式などの、任意の特別なバリアント設定を定義します。

Locale パラメータにより、FormatTime 関数の出力で時刻文字列が解釈され、表示される方法に対して、指定したロケール定義が適用されます。 このパラメータの値は、Windowsオペレーティング システムのロケール名に基づきます。 たとえば、フランス語（カナダ）のロケール名は「fr-CA」です。 サポートされているロケールの一覧については、Microsoft の『National Language Support Reference』の「Locale Identifier Constants and Strings」というトピックを参照してください。

注: 使用可能なロケールは、オペレーティング システムのバージョンと[地域のオプション]の設定に基づきます。

解説

すべてのパラメータが必須です。 Format または Locale パラメータのデフォルト値を使用するには、式に「Default」と入力します。 以下の例では、FormatTime 関数により、現在のシステムの時刻が、オペレーティング システムの時刻形式とロケールを使用して返されます。 

FormatTime ("Current","Default", "Default")

以下の各例は、Format パラメータの要素を使用して FormatTime 関数の出力をカスタマイズする方法を示しています。 

FormatTime("9:05:08 PM", "hh:mm:ss tt", "en-US") returns "09:05:08 PM"

FormatTime("9:05:08 PM", "HH:mm:ss", "en-US") returns "21:05:08"

FormatTime("9:05:08 PM", "tt", "Default") returns "PM"

以下の例は、Locale パラメータを使用して、英語（米国）と英語（英国）の各ロケールの出力に影響を与える方法を示しています。 

FormatTime("14:30", "Default", "en-US") returns "2:30:00 PM"

FormatTime("14:30", "Default", "en-GB") returns "14:30:00"
親トピック: 式デザイナ