formatTime()
strLib.formatTime() システム関数は、入力として TIME 値を受け入れ、STRING 値を戻します。
EGL は、変換のためのフォーマットを以下の順序で決定します。
各フォーマットが NULL、空、または無効の場合、EGL は次に進みます。
- パラメーターとして指定されたフォーマット・ストリング
- strLib.defaultTimeFormat
- Java™ ロケール・オブジェクトの時刻形式 (Java のみ)
これらがすべて失敗した場合、戻り値は NULL になります。
構文
strLib.formatTime(
aTime TIME? in
[, timeFormat STRING? in] )
returns (result STRING?)
- aTime
- フォーマットする値。 dateTimeLib.currentTime() システム関数の戻り値など、TIME 値と代入互換性のある任意の式を入力することができます。
- timeFormat
- 時刻形式を識別します。説明は、日付/時刻マスクとフォーマット指定子にあります。 リテラル、ストリング変数、またはEGL ライブラリー strLibで説明されている任意の時刻形式定数を使用することができます。
- result
- STRING 値。aTime が NULL であるか、EGL が有効なフォーマットを検出できない場合、関数は NULL 値を戻します。
例
以下の例では、夏の米国西海岸の午後 12:32 であると仮定としています。
myFormat STRING = "hh 'o''clock' a, zzzz";
result STRING;
result = strLib.formatTime(dateTimeLib.currentTime(),myFormat);
// 結果は「米国太平洋夏時間、午後 12 時」です