「DateTimeクラス」の版間の差分
(まだ書きかけです。) |
(→Today) |
||
(2人の利用者による、間の9版が非表示) | |||
1行目: | 1行目: | ||
'''DateTime クラス''' | '''DateTime クラス'''は、日付・時刻を表すクラスです。また、時刻の種類 (現地時刻, 世界協定時刻 (UTC), どちらでもない)を保持します。 | ||
== クラスの機能 == | == クラスの機能 == | ||
45行目: | 45行目: | ||
==== DayOfWeek ==== | ==== DayOfWeek ==== | ||
Function DayOfWeek() As DayOfWeek | Function DayOfWeek() As [[DayOfWeek列挙体|DayOfWeek]] | ||
このインスタンスで表される時刻の、曜日を取得します。 | |||
==== Kind ==== | ==== Kind ==== | ||
Function Kind() As | Function Kind() As [[DateTimeKind列挙体|DateTimeKind]] | ||
このインスタンスが、現地時刻,世界協定時刻(UTC) | このインスタンスが、現地時刻,世界協定時刻 (UTC)なのかを取得します。 | ||
==== DayOfYear ==== | ==== DayOfYear ==== | ||
65行目: | 65行目: | ||
==== Today ==== | ==== Today ==== | ||
Static Function | Static Function Today() As DateTime | ||
現在の現地時刻の日付部分を表した、新しいDateTimeインスタンスを返します。 | 現在の現地時刻の日付部分を表した、新しいDateTimeインスタンスを返します。 | ||
77行目: | 77行目: | ||
Sub DateTime(ticks As Int64, kind As DateTimeKind) | Sub DateTime(ticks As Int64, kind As DateTimeKind) | ||
100ナノ秒単位で表した時刻を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | 100ナノ秒単位で表した時刻を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | ||
Sub DateTime(year As Long, month As Long, day As Long) | Sub DateTime(year As Long, month As Long, day As Long) | ||
Sub DateTime(year As Long, month As Long, day As Long, kind As DateTimeKind) | Sub DateTime(year As Long, month As Long, day As Long, kind As DateTimeKind) | ||
年,月,日を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | 年,月,日を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | ||
Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long) | Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long) | ||
Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, kind As DateTimeKind) | Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, kind As DateTimeKind) | ||
年,月,日,時間,分,秒を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | 年,月,日,時間,分,秒を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | ||
Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, millisecond As Long) | Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, millisecond As Long) | ||
Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, millisecond As Long, kind As DateTimeKind) | Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, millisecond As Long, kind As DateTimeKind) | ||
年,月,日,時間,分,秒,ミリ秒を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | 年,月,日,時間,分,秒,ミリ秒を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | ||
Sub DateTime(ByRef time As SYSTEMTIME) | Sub DateTime(ByRef time As SYSTEMTIME) | ||
Sub DateTime(ByRef time As SYSTEMTIME, kind As DateTimeKind) | Sub DateTime(ByRef time As SYSTEMTIME, kind As DateTimeKind) | ||
SYSTEMTIME構造体を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | SYSTEMTIME構造体を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。 | ||
==== Operator+ ==== | |||
Function Operator+ (value As [[TimeSpanクラス|TimeSpan]]) As DateTime | |||
このインスタンスの時刻に、valueの時間だけ加算します。valueは[[TimeSpanクラス|TimeSpan]]で指定します。 | |||
==== Operator- ==== | |||
Function Operator- (value As [[TimeSpanクラス|TimeSpan]]) As DateTime | |||
このインスタンスの時刻から、valueの時間だけ減算します。valueは[[TimeSpanクラス|TimeSpan]]で指定します。 | |||
Function Operator- (value As DateTime) As [[TimeSpanクラス|TimeSpan]] | |||
このインスタンスとvalueで指定した時刻の差を[[TimeSpanクラス|TimeSpan]]で返します。 | |||
==== Operator == ==== | ==== Operator == ==== | ||
Function Operator == (ByRef value As DateTime) As | Function Operator == (ByRef value As DateTime) As Boolean | ||
[[#Equals|Equals]](value)を返します。 | [[#Equals|Equals]](value)を返します。 | ||
==== Operator <> ==== | ==== Operator <> ==== | ||
Function Operator <> ( | Function Operator <> (value As DateTime) As Boolean | ||
Not [[#Equals|Equals]](value)を返します。 | Not [[#Equals|Equals]](value)を返します。 | ||
==== Operator > ==== | ==== Operator > ==== | ||
Function Operator > ( | Function Operator > (value As DateTime) As Boolean | ||
このインスタンスとvalueのTicksを比較して、valueより大きければTrueを返します。それ以外はFalseです。 | |||
==== Operator < ==== | ==== Operator < ==== | ||
Function Operator < ( | Function Operator < (value As DateTime) As Boolean | ||
このインスタンスとvalueのTicksを比較して、valueより小さければTrueを返します。それ以外はFalseです。 | |||
==== Operator => ==== | ==== Operator => ==== | ||
Function Operator => ( | Function Operator => (value As DateTime) As Boolean | ||
このインスタンスとvalueのTicksを比較して、value以上ならばTrueを返します。それ以外はFalseです。 | |||
==== Operator <= ==== | ==== Operator <= ==== | ||
Function Operator <= ( | Function Operator <= (value As DateTime) As Boolean | ||
このインスタンスとvalueのTicksを比較して、value以下ならばTrueを返します。それ以外はFalseです。 | |||
==== Compare ==== | ==== Compare ==== | ||
Static Function Compare( | Static Function Compare(t1 As DateTime, t2 As DateTime) As Int64 | ||
t1がt2より小さければ、負の値を返します。t1がt2より大きければ、正の値を返します。また、t1とt2が等しい場合、0を返します。 | t1がt2より小さければ、負の値を返します。t1がt2より大きければ、正の値を返します。また、t1とt2が等しい場合、0を返します。 | ||
==== Equals ==== | ==== Equals ==== | ||
Function Equals( | Function Equals(value As DateTime) As Boolean | ||
このインスタンスとvalueが、同一の時刻場合Trueを返します。それ以外はFalseです。 | |||
==== AddTicks ==== | ==== AddTicks ==== | ||
Function AddTicks(value As Int64) As DateTime | |||
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは100ナノ秒単位です。 | |||
==== AddMilliseconds ==== | ==== AddMilliseconds ==== | ||
Sub AddMilliseconds(value As Double) | Sub AddMilliseconds(value As Double) | ||
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueはミリ秒単位です。 | |||
==== AddSeconds ==== | ==== AddSeconds ==== | ||
Sub AddSeconds(value As Double) | Sub AddSeconds(value As Double) | ||
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは秒単位です。 | |||
==== AddMinutes ==== | ==== AddMinutes ==== | ||
Sub AddMinutes(value As Double) | Sub AddMinutes(value As Double) | ||
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは分単位です。 | |||
==== AddHours ==== | ==== AddHours ==== | ||
Sub AddHours(value As Double) | Sub AddHours(value As Double) | ||
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは時間単位です。 | |||
==== AddDays ==== | ==== AddDays ==== | ||
Sub AddDays(value As Double) | Sub AddDays(value As Double) | ||
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは日単位です。 | |||
==== AddYears ==== | ==== AddYears ==== | ||
Sub AddYears(value As Double) | Sub AddYears(value As Double) | ||
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは年単位です。小数を指定した場合、最初に整数部分だけ時刻を進めた後、そのあと、その年の日数から計算した小数部分の時刻だけ進めます。 | |||
==== DaysInMonth ==== | ==== DaysInMonth ==== | ||
Function DaysInMonth(year As Long, month As Long) As Long | Static Function DaysInMonth(year As Long, month As Long) As Long | ||
指定した年の月の日数を返します。 | 指定した年の月の日数を返します。 | ||
==== IsLeapYear ==== | ==== IsLeapYear ==== | ||
Function IsLeapYear(year As Long) As BOOL | Static Function IsLeapYear(year As Long) As BOOL | ||
このインスタンスが表す年が、閏年の場合TRUEを返します。それ以外はFALSEです。 | このインスタンスが表す年が、閏年の場合TRUEを返します。それ以外はFALSEです。 | ||
==== GetDateTimeFormats ==== | ==== GetDateTimeFormats ==== | ||
Function GetDateTimeFormats() As String | Function GetDateTimeFormats() As String | ||
Function GetDateTimeFormats(format As *Byte) As String | |||
; format | |||
: 書式文字列を指定します。[http://www.activebasic.com/help_center/Pages/API/SystemService/StringManipulation/GetDateFormat.htm GetDateFormat]と[http://www.activebasic.com/help_center/Pages/API/SystemService/StringManipulation/GetDateFormat.htm GetTimeFormat]の書式文字列を、組み合わせて指定します。省略した場合、デフォルトのフォーマット文字列が返ります。 | |||
このインスタンスの時刻を、文字列で表した新しい[[Stringクラス|String]]インスタンスを返します。 | |||
==== FromBinary ==== | ==== FromBinary ==== | ||
180行目: | 197行目: | ||
==== ToFileTimeUtc ==== | ==== ToFileTimeUtc ==== | ||
Function ToFileTimeUtc() As FILETIME | Function ToFileTimeUtc() As FILETIME | ||
このインスタンスの時刻の、世界協定時刻( | このインスタンスの時刻の、世界協定時刻 (UTC)で初期化した、FILETIME構造体を返します。このインスタンスの時刻が、現地時刻の場合、世界協定時刻 (UTC)に変換されます。 | ||
==== ToLocalTime ==== | ==== ToLocalTime ==== | ||
Function ToLocalTime() As DateTime | Function ToLocalTime() As DateTime | ||
このインスタンスの時刻を現地時刻で表した、新しいDateTimeインスタンスを返します。 | このインスタンスの時刻を現地時刻で表した、新しいDateTimeインスタンスを返します。 | ||
==== ToUnivarsalTime ==== | |||
Function ToUniversalTime() As DateTime | |||
このインスタンスの時刻を世界協定時刻 (UTC)で表した、新しいDateTimeインスタンスを返します。 | |||
[[Category:System名前空間]] |
2007年9月9日 (日) 10:06時点における最新版
DateTime クラスは、日付・時刻を表すクラスです。また、時刻の種類 (現地時刻, 世界協定時刻 (UTC), どちらでもない)を保持します。
クラスの機能
定数
MaxValue
Static MaxValue As Int64
DateTimeが扱うことの出来る、最大の時刻を表します。最大の時刻は、9999年です。
MinValue
Static MinValue As Int64
DateTimeが扱うことのできる、最小の時刻を表します。最小の時刻は、1年です。
プロパティ
Ticks
Function Ticks() As Int64
このインスタンスで表される時刻を、100ナノ秒単位の時刻で取得します。
Millisecond
Function Millisecond() As Long
このインスタンスで表される時刻の、ミリ秒の部分を取得します。
Second
Function Second() As Long
このインスタンスで表される時刻の、秒の部分を取得します。
Minute
Function Minute() As Long
このインスタンスで表される時刻の、分の部分を取得します。
Hour
Function Hour() As Long
このインスタンスで表される時刻の、時間の部分を取得します。
Day
Function Day() As Long
このインスタンスで表される時刻の、日の部分を取得します。
Month
Function Month() As Long
このインスタンスで表される時刻の、月の部分を取得します。
Year
Function Year() As Long
このインスタンスで表される時刻の、年の部分を取得します。
DayOfWeek
Function DayOfWeek() As DayOfWeek
このインスタンスで表される時刻の、曜日を取得します。
Kind
Function Kind() As DateTimeKind
このインスタンスが、現地時刻,世界協定時刻 (UTC)なのかを取得します。
DayOfYear
Function DayOfYear() As Long
このインスタンスで表される時刻の、その年で通算何日経過しているかを取得します。
Date
Function Date() As DateTime
このインスタンスで表される時刻の、日付部分だけを抜き出した、新しいDateTimeインスタンスを返します。
Now
Static Function Now() As DateTime
現在の現地時刻を表した、新しいDateTimeインスタンスを返します。
Today
Static Function Today() As DateTime
現在の現地時刻の日付部分を表した、新しいDateTimeインスタンスを返します。
UtcNow
Static Function UtcNow() As DateTime
現在の世界協定時刻(UTC)を表した、新しいDateTimeインスタンスを返します。
メソッド
コンストラクタ
Sub DateTime(ticks As Int64) Sub DateTime(ticks As Int64, kind As DateTimeKind)
100ナノ秒単位で表した時刻を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。
Sub DateTime(year As Long, month As Long, day As Long) Sub DateTime(year As Long, month As Long, day As Long, kind As DateTimeKind)
年,月,日を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。
Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long) Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, kind As DateTimeKind)
年,月,日,時間,分,秒を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。
Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, millisecond As Long) Sub DateTime(year As Long, month As Long, day As Long, hour As Long, minute As Long, second As Long, millisecond As Long, kind As DateTimeKind)
年,月,日,時間,分,秒,ミリ秒を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。
Sub DateTime(ByRef time As SYSTEMTIME) Sub DateTime(ByRef time As SYSTEMTIME, kind As DateTimeKind)
SYSTEMTIME構造体を指定して、DateTimeを初期化します。kindを指定することにより、世界協定時刻か現地時刻なのかを指定することができます。
Operator+
Function Operator+ (value As TimeSpan) As DateTime
このインスタンスの時刻に、valueの時間だけ加算します。valueはTimeSpanで指定します。
Operator-
Function Operator- (value As TimeSpan) As DateTime
このインスタンスの時刻から、valueの時間だけ減算します。valueはTimeSpanで指定します。
Function Operator- (value As DateTime) As TimeSpan
このインスタンスとvalueで指定した時刻の差をTimeSpanで返します。
Operator ==
Function Operator == (ByRef value As DateTime) As Boolean
Equals(value)を返します。
Operator <>
Function Operator <> (value As DateTime) As Boolean
Not Equals(value)を返します。
Operator >
Function Operator > (value As DateTime) As Boolean
このインスタンスとvalueのTicksを比較して、valueより大きければTrueを返します。それ以外はFalseです。
Operator <
Function Operator < (value As DateTime) As Boolean
このインスタンスとvalueのTicksを比較して、valueより小さければTrueを返します。それ以外はFalseです。
Operator =>
Function Operator => (value As DateTime) As Boolean
このインスタンスとvalueのTicksを比較して、value以上ならばTrueを返します。それ以外はFalseです。
Operator <=
Function Operator <= (value As DateTime) As Boolean
このインスタンスとvalueのTicksを比較して、value以下ならばTrueを返します。それ以外はFalseです。
Compare
Static Function Compare(t1 As DateTime, t2 As DateTime) As Int64
t1がt2より小さければ、負の値を返します。t1がt2より大きければ、正の値を返します。また、t1とt2が等しい場合、0を返します。
Equals
Function Equals(value As DateTime) As Boolean
このインスタンスとvalueが、同一の時刻場合Trueを返します。それ以外はFalseです。
AddTicks
Function AddTicks(value As Int64) As DateTime
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは100ナノ秒単位です。
AddMilliseconds
Sub AddMilliseconds(value As Double)
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueはミリ秒単位です。
AddSeconds
Sub AddSeconds(value As Double)
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは秒単位です。
AddMinutes
Sub AddMinutes(value As Double)
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは分単位です。
AddHours
Sub AddHours(value As Double)
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは時間単位です。
AddDays
Sub AddDays(value As Double)
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは日単位です。
AddYears
Sub AddYears(value As Double)
このインスタンスの時刻を、valueだけ進めたDateTimeを作成します。valueは年単位です。小数を指定した場合、最初に整数部分だけ時刻を進めた後、そのあと、その年の日数から計算した小数部分の時刻だけ進めます。
DaysInMonth
Static Function DaysInMonth(year As Long, month As Long) As Long
指定した年の月の日数を返します。
IsLeapYear
Static Function IsLeapYear(year As Long) As BOOL
このインスタンスが表す年が、閏年の場合TRUEを返します。それ以外はFALSEです。
GetDateTimeFormats
Function GetDateTimeFormats() As String Function GetDateTimeFormats(format As *Byte) As String
- format
- 書式文字列を指定します。GetDateFormatとGetTimeFormatの書式文字列を、組み合わせて指定します。省略した場合、デフォルトのフォーマット文字列が返ります。
このインスタンスの時刻を、文字列で表した新しいStringインスタンスを返します。
FromBinary
Static Function FromBinary(dateData As Int64) As DateTime
64bit変数で表されたDateTimeから作成した、新しいDateTimeインスタンスを返します。ToBinaryメソッドで作成した64bit変数から、DateTimeクラスを再構築することができます。
ToBinary
Function ToBinary() As Int64
このインスタンスの情報が保存された、64bit変数が返ります。FromBinaryメソッドを使用することにより、64bit変数で表されたDateTimeを、DateTimeクラスに再構築することができます。
FromFileTime
Static Function FromFileTime(fileTime As FILETIME) As DateTime
指定されたWindowsファイル時刻で、現地時刻に初期化した、新しいDateTimeインスタンスが返ります。
ToFileTime
Function ToFileTime() As FILETIME
このインスタンスの時刻で初期化した、FILETIME構造体を返します。
FromFileTimeUtc
Static Function FromFileTimeUtc(fileTime As FILETIME) As DateTime
指定されたWindowsファイル時刻で、世界協定時刻(Utc)に初期化した、新しいDateTimeインスタンスが返ります。
ToFileTimeUtc
Function ToFileTimeUtc() As FILETIME
このインスタンスの時刻の、世界協定時刻 (UTC)で初期化した、FILETIME構造体を返します。このインスタンスの時刻が、現地時刻の場合、世界協定時刻 (UTC)に変換されます。
ToLocalTime
Function ToLocalTime() As DateTime
このインスタンスの時刻を現地時刻で表した、新しいDateTimeインスタンスを返します。
ToUnivarsalTime
Function ToUniversalTime() As DateTime
このインスタンスの時刻を世界協定時刻 (UTC)で表した、新しいDateTimeインスタンスを返します。