日付と時刻を検証し、内部形式に変換します。
Synopsis
$ZDATETIMEH(datetime,dformat,tformat,monthlist,yearopt,startwin,endwin,mindate,maxdate,erropt)
$ZDTH(datetime,dformat,tformat,monthlist,yearopt,startwin,endwin,mindate,maxdate,erropt)
パラメータ
datetime 表示形式で指定された日付と時刻値。これは、$HOROLOG 形式に変換する日付と時刻です。
dformat オプションdatetime 値の日付部分に対応する日付形式。
tformat オプションdatetime 値の時刻部分に対応する時刻形式。
monthlist オプション — 月の名前のリスト (または、月の省略名) を含む文字列。この文字列は、区切り文字から始まり、12 個のエントリは、この区切り文字で分けられる必要があります。
yearopt オプション — 年を 2 桁の値として表記する時間ウィンドウ。
startwin オプション — 日付を 2 桁の年で表す必要があるスライディング・ウィンドウの最初を指定する数値。
endwin オプション — 日付を 2 桁の年で表す必要があるスライディング・ウィンドウの最後を指定する数値。
mindate オプション — 有効な日付範囲の下限。
maxdate オプション — 有効な日付範囲の上限。
erropt オプション — このパラメータは、datetime 値が無効、あるいは範囲外の場合に生じるエラー・メッセージを制御します。
概要
$ZDATETIMEH は、指定された日付と時刻値を検証し、これを表示形式から内部形式に変換します。対応する $ZDATETIME 関数は、日付と時刻値を内部形式から表示形式に変換します。内部形式は、$HOROLOG または $ZTIMESTAMP によって使用される形式です。コンマで区切られた 2 つの数値の文字列として、日付と時刻値を表します。
返される値は、使用するパラメータによって異なります。
$ZDATETIMEH(datetime) は、日付と時刻値を "MM/DD/[YY]YY hh:mm:ss[.ffff]" 形式から $HOROLOG 形式に変換します。
構文 意味
MM 2 桁の月
DD 2 桁の日
[YY]YY 1900 年から 1999 年までは 2 桁または 4 桁。1900 年より前、または 1999 年より後の年は 4 桁
hh 24 時間形式の時間
mm
ss
ffff 小数秒 (小数点以下 0 から 9 桁まで)
$ZDATETIMEH(datetime,dformat,tformat,monthlist,yearopt,startwin,endwin,mindate,maxdate,erropt) は、($ZDATETIMEを使用して) 最初に指定された日付と時刻値を $HOROLOG 形式または $ZTIMESTAMP 形式に変換します。dformattformatyearoptstartwin および endwin の値は、$ZDATETIME によって使用される値と同一です。
しかし、5、6、7、8、9 の dformat を使用するとき、$ZDATETIMEH は、dformat コード 1、2、3、5、6、7、8、9 に対応する、外部の日付形式によるあらゆる日付を認識し、変換します。また、T あるいは t で始まる特殊な相対日付形式も同様で、任意にプラス (+) やマイナス (-) を付けたり、現在の日付の前もしくは後の日数を付けます。
$ZDATETIMEH は、関数呼び出しで指定した時刻形式に関係なく、8 つの時刻形式の時刻をすべて認識して変換します。さらに、$ZDATETIMEH は、接尾語 "AM、PM、NOON、MIDNIGHT" を認識して変換します。これらの接尾語は、大文字、小文字、または両方を混ぜ合わせて表すことができます。これらの接尾語を文字に省略することもできます。
認識する形式は、以下のとおりです。
パラメータ値
datetime
$HOROLOG 形式に変換する日付と時刻。datetime は、先頭に日付、その後に 1 つの空白スペース、時刻と続く 1 つの文字列に評価される式として指定します。時刻部分を省略する場合、$ZDATETIMEH$HOROLOG 形式の時刻部分をゼロに設定します。有効な日付値、および時刻値は、現在のロケールの DateFormat プロパティと TimeFormat プロパティ、および dformat パラメータと tformat パラメータに指定する値によって異なります。日付に関する詳細は、"$ZDATEH" を参照してください。
dformat
日付の形式です。有効な値は以下のとおりです。
意味
-1 現在のロケールの DateFormat プロパティから、有効な dformat 値を取得します。既定は 1 です。dformat を指定しなければ、これが既定になります。
1 MM/DD/[YY]YY (01/01/97 あるいは 03/27/2002) - 既定の形式
2 DD Mmm [YY]YY (01 Jul 97 あるいは 27 Mar 2002)
3 YYYY-MM-DD (1997-07-01 あるいは 2002-03-27) - ODBC 形式
4 DD/MM/[YY]YY (01/07/97 あるいは 27/03/2002) - ヨーロッパ形式
5 Mmm D, YYYY (Jul 1, 1997 あるいは Mar 27, 2002)
6 Mmm D YYYY (Jul 1 1997 あるいは Mar 27 2002)
7 Mmm DD [YY]YY (Jul 01 1997 あるいは Mar 27 2002)
8 YYYYMMDD (19930701 あるいは 20020327) - 数値形式
9 Mmmmm D, YYYY (July 1, 1997 あるいは March 27, 2002)
以下はその説明です。
構文 意味
YYYY YYYY は 4 桁の年です。[YY]YY は、datetime の年がアクティブ・ウィンドウ内で 2 桁に収まる場合は 2 桁、それ以外は 4 桁の数字です。
MM 2 桁の月。
D 日付が 10 未満の場合は 1 桁、それ以外は 2 桁の日。
DD 2 桁の日。
Mmm
Mmm は、現在のロケールの MonthAbbr プロパティから取得した月の省略形です。以下はその既定値です。
"Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
別の月の省略形 (あるいは長さに制限のない名前) は、$ZDATETIMEHmonthlist パラメータとして指定したオプションのリストから取得することができます。
Mmmmm
MonthName プロパティが指定する月の正式な名前。以下はその既定値です。"January February March ... November December"
別の月の名前は、$ZDATETIMEHmonthlist パラメータとして指定したオプションのリストから取得することができます。
tformat
時刻の値を表記する形式を指定する数値です。サポートされている値は、以下のとおりです。
意味
-1 現在のロケールの TimeFormat プロパティから、有効な tformat 値を取得します。既定は 1 です。tformat を指定しなければ、これが既定の振る舞いになります。
1 時刻を "hh:mm:ss" (24 時間) の形式で表します。
2 時刻を "hh:mm" (24 時間) の形式で表します。
3 時刻を "hh:mm:ss[AM/PM]" (12 時間) の形式で表します。
4 時刻を “hh:mm[AM/PM]" (12 時間) の形式で表します。
5 時刻を "hh:mm:ss+/-hh:mm" (24 時間) の形式で表します。時刻を現地時間で表します。プラス (+) またはマイナス(–) 接尾語は、グリニッジ標準時間 (GMT) としても知られる、協定世界時 (UTC) からの現地時間のオフセットを示します。マイナス符号 (-hh:mm) は、返された時間と分のオフセット数により、現地時間がグリニッジ標準時間より早い (西向きである) ことを示します。プラス符号 (+hh:mm) は、返された時間と分のオフセット数により、現地時間がグリニッジ標準時間より遅い (東向きである) ことを示します。
6 時刻を "hh:mm+/-hh:mm" (24 時間) の形式で表します。時刻を現地時間で表します。プラス (+) またはマイナス(–) 接尾語は、グリニッジ標準時間 (GMT) としても知られる、協定世界時 (UTC) からの現地時間のオフセットを示します。マイナス符号 (-hh:mm) は、返された時間と分のオフセット数により、現地時間がグリニッジ標準時間より早い (西向きである) ことを示します。プラス符号 (+hh:mm) は、返された時間と分のオフセット数により、現地時間がグリニッジ標準時間より遅い (東向きである) ことを示します。
7 時刻を "hh:mm:ssZ" (24 時間) の形式で表します。"Z" 接尾語は、時刻が現地時間ではなく、グリニッジ標準時間 (GMT) としても知られる、協定世界時 (UTC) で表示されていることを示します。
8 時刻を "hh:mmZ" (24 時間) で表します。"Z" 接尾語は、時刻が現地時間ではなく、グリニッジ標準時間 (GMT) としても知られる、協定世界時 (UTC) で表示されていることを示します。
tformat 値が (現地時間を返す) 1 から 4 までの場合、日付と時刻はスペースで区切られます。tformat 値が (UTC 時間の情報を返す) 5 から 8 までの場合、日付と時刻は文字 "T" で区切られます。
tformat が 7 または 8 に設定される場合、時刻は UTC 時間で返され、返される日付も (必要であれば) UTC 時間値に調整されます。この日付は、現地日付とは異なる場合があります。
monthlist
月名の文字列を含む文字列あるいは変数名です。monthlist にある名前は、既定の月名の値と月の省略値を置き換え、現在のロケールの MonthName プロパティと MonthAbbr プロパティをオーバーライドします。monthlist の最も一般的な用途は、ロケールの既定言語以外の言語で、正式な月名または省略名を指定することです。
monthlist は、dformat が 2、5、6、7、または 9 の場合にのみ有効です。dformat が -1、1、3、4、または 8 の場合、$ZDATETIMEHmonthlist を無視します。
monthlist 文字列の形式は、以下のとおりです。
monthlist を省略するか、または monthlist 値に -1 を指定して、dformat が 2、5、6、または 7 の場合、$ZDATETIMEH は現在のロケールの MonthAbbr プロパティで定義された月の省略名リストを使用します。既定は以下のとおりです。"Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
monthlist を省略するか、または monthlist 値に -1 を指定して、dformat が 9 の場合、$ZDATETIMEH は現在のロケールの MonthName プロパティで定義された月名のリストを使用します。既定は以下のとおりです。"January February March April May June July August September October November December"
yearopt
dformat 値に 0、1、2、4、7 を使用して、年を 2 桁で表示する時間ウィンドウを指定する数値コードです。yearopt の値は以下のとおりです。
意味
-1 現在のロケールの YearOption プロパティから有効な yearopt 値を取得します。この既定値は 0 です。yearopt を指定しない場合、これが既定の振る舞いになります。
0 (%DATE ユーティリティにより構築される) プロセス特有のスライディング・ウィンドウが有効になっていない限り、20 世紀 (1900 年から 1999 年まで) の日付は 2 桁で表示します。スライディング・ウィンドウが有効な場合は、指定範囲内の日付のみ 2 桁の年で表示します。1900 年代以外もしくはプロセス特有のスライディング・ウィンドウ以外の日付は、すべて 4 桁で表示します。
1 20 世紀の日付は 2 桁の年、それ以外は 4 桁で表します。
2 すべての日付を 2 桁の年で表します。
3 startwin と (オプションで) endwin に定義した一時的なスライディング・ウィンドウ範囲内に収まる日付を、2 桁の年で表します。それ以外の日付は 4 桁で表します。yearopt =3 の場合、startwinendwin は、$HOROLOG 形式の絶対日付です。
4 すべての日付を 4 桁の年で表します。
5 startwin と (オプションで) endwin に定義したスライディング・ウィンドウ範囲内に収まる日付をすべて、2 桁の年で表します。それ以外の日付は 4 桁で表します。yearopt=5 の場合、startwinendwin は相対年になります。
6 2 桁の年で現在の世紀にあるすべての日付を表します。それ以外は 4 桁の年で表します。
startwin
日付を 2 桁の年で表す必要があるスライディング・ウィンドウの最初を指定する数値です。yearopt の値に 3 または 5 を使用する場合は、startwin を指定する必要があります。startwin は、その他の yearopt 値では無効になります。
yearopt=3 のとき、startwin はスライディング・ウィンドウの最初の日付を示す $HOROLOG 日付形式の絶対日付です。
yearopt=5 のとき、startwin は、現在の年より前の年数で表される、スライディング・ウィンドウの最初の年を示す数値です。スライディング・ウィンドウは常に、startwin で指定した年の初日 (1 月 1 日) から開始します。
endwin
日付を 2 桁の年で表すスライディング・ウィンドウの最後を指定する数値です。yearopt が 3 あるいは 5 のとき、endwin を指定する必要があります。endwin は、その他の yearopt 値では無効になります。
yearopt=3 のとき、endwin はスライディング・ウィンドウの最後の日付を示す $HOROLOG 日付形式の絶対日付です。
yearopt=5 のとき、endwin は、現在の年から後の年数を示すスライディング・ウィンドウの最後の年を示す数値です。スライディング・ウィンドウは常に、endwin で指定した年の 12 月 31 日で終了します。endwin を指定しない場合、既定は、startwin 以降 100 年後の 12 月 31 日です。
endwin を省略、あるいは -1 を指定した場合、スライディング・ウィンドウの有効期限は 100 年間です。
startwinendwin の両方を指定する場合、指定するスライディング・ウィンドウの年数は 100 年以内に収める必要があります。
mindate
有効な日付の下限を指定する数値です。mindate を省略、あるいは -1 を指定すると、現在のロケールの DateMinimum プロパティから下限を取得します。既定は 0 (1840 年 12 月 31 日) です。
maxdate
有効な日付の上限を指定する数値です。maxdateを省略、あるいは -1 を指定すると、現在のロケールの DateMaximum プロパティから上限を取得します。既定は、$HOROLOG の日付部分で許容される最大値である、2980013 (9999 年 12 月 31 日) です。maxdate を超える値を指定しようとすると、<VALUE OUT OF RANGE> エラー・メッセージが発生します。
erropt
このパラメータは、datetime 値が無効あるいは範囲外の場合に生じるエラー・メッセージを制御します。<ILLEGAL VALUE> あるいは <VALUE OUT OF RANGE> エラー・メッセージを生成する代わりに、関数は erropt を返します。
メモ
$ZDATETIMEH と秒の小数部
$ZDATETIME とは異なり、$ZDATETIMEH は時刻の精度を指定することはできません。元の $ZDATETIME 時刻形式の秒の小数部は、$ZDATETIMEH が返す値に保持されます。
$HOROLOG 形式も秒の小数部を返しません。
$ZDATETIMEH で無効な値
以下の状況では、<FUNCTION> エラーが発生します。
以下の状況では、<ILLEGAL VALUE> エラーが発生します。
以下の状況では、<VALUE OUT OF RANGE> エラーが発生します。
erropt を使用するエラー処理
erropt パラメータが指定されている場合、このパラメータは、datetime の無効な値、あるいは範囲外の値が原因で生成されるエラー・メッセージを制御します。他のパラメータの無効な値、あるいは範囲外の値が原因で発生したエラーについては、erropt が指定されているかどうかに関係なく、常にエラー・メッセージが生成されます。
例えば、$ZDATETIMEHendwinstartwin より前になる値のスライディング・ウィンドウを指定すると、常に <ILLEGAL VALUE> エラーが発生します。同様に、maxdatemindate より小さい場合、<ILLEGAL VALUE> エラーが発生します。
日付区切り文字
$ZDATETIMEH は、dformat が 1 または 4 のとき、年月日の区切り文字として現在のロケールの DateSeparator プロパティの値を使用します。ODBC 日付形式 (dformat=3) の区切り文字は常に、ODBC 基準で要求されている "-" になります。DateSeparator の既定値は "/" であり、この区切り文字は Caché のすべてのドキュメントで使用されています。
時間区切り文字
既定では、Caché は、現在のロケールの TimeSeparator プロパティ値を使用して、時間の区切り文字を指定します。既定では、区切り文字は ":" で、すべての例でこの区切り文字を使用しています。ODBC 日付形式 (dformat=3) の区切り文字は常に、ODBC 基準で要求されている ":" になります。
小数秒の区切り文字は、小数点 (.) です。
時間接尾語
既定では、Caché は現在のロケールのプロパティを使用して、時間の接尾語名を指定します。$ZDATETIMEH で、これらのプロパティ (および、対応する既定値) は以下のとおりです。
このドキュメントでは、これらのプロパティに常に既定値を使用します。
$ZDATEH と $ZDATETIMEH
$ZDATETIMEH は、$ZDATEH に似ています。$ZDATETIMEH が日付と時刻の値の両方を内部 $HOROLOG 形式に変換するのに対し (時刻値を指定していない場合でも)、$ZDATEH は、日付の値だけを $HOROLOG 形式に変換する点が異なります。例えば以下のようになります。
   WRITE $ZDATEH("Nov 25, 2002",5)
これは、59133 を返します。
   WRITE $ZDATETIMEH("Nov 25, 2002 10:08:09.539",5)
これは、59133,36489.539 を返します。
$ZDATETIMEH に値を指定しない場合
   WRITE $ZDATETIMEH("Nov 25, 2002",5)
これは、59133,0 を返します。
関連項目