Sancho at 16:52, 2 September 2011

2011-09-02T16:52:51Z

Sancho: moved EN/documentation/basic guide/date and time (runtime library) to EN/documentation/basic guide/date and time runtime library

2011-09-02T16:45:21Z

moved EN/documentation/basic guide/date and time (runtime library) to EN/documentation/basic guide/date and time runtime library

Sancho: Основной текст

2011-09-02T10:42:23Z

Основной текст

New page

<section begin=title /><noinclude>{{DISPLAYTITLE:</noinclude>Date and Time ({{OOo}} Runtime Library)<noinclude>}}</noinclude><section end=title />{{BreadCrumbL10n}}

{{Documentation/BASICGuideTOC
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=EN/documentation/basic_guide/strings_(runtime_library)
|NextPage=EN/documentation/basic_guide/files_and_directories_(runtime_library)
|runtime=block
}}

{{OOo}} Basic provides the <tt>Date</tt> data type, which saves the date and time details in binary format.

== Specification of Date and Time Details within the Program Code ==

You can assign a date to a date variable through the assignment of a simple string:

<source lang="oobas">
Dim MyDate As Date
MyDate = "24.1.2002"
</source>

This assignment can function properly because {{OOo}} Basic automatically converts the date value defined as a string into a date variable. This type of assignment, however, can cause errors, date and time values are defined and displayed differently in different countries.

Since {{OOo}} Basic uses the country-specific settings of the operating system when converting a string into a date value, the expression shown previously only functions correctly if the country-specific settings match the string expression.

To avoid this problem, the <tt>DateSerial</tt> function should be used to assign a fixed value to a date variable:

<source lang="oobas">
Dim MyVar As Date
MyDate = DateSerial (2001, 1, 24)
</source>

The function parameter must be in the sequence: year, month, day. The function ensures that the variable is actually assigned the correct value regardless of the country-specific settings

The <tt>TimeSerial</tt> function formats time details in the same way that the <tt>DateSerial</tt> function formats dates:

<source lang="oobas">
Dim MyVar As Date
MyDate = TimeSerial(11, 23, 45)
</source>

Their parameters should be specified in the sequence: hours, minutes, seconds.

== Extracting Date and Time Details ==

The following functions form the counterpart to the <tt>DateSerial</tt> and <tt>TimeSerial</tt> functions:

;<tt>Day(MyDate)</tt>:returns the day of the month from <tt>MyDate</tt>.
;<tt>Month(MyDate)</tt>:returns the month from <tt>MyDate</tt>.
;<tt>Year(MyDate)</tt>:returns the year from <tt>MyDate</tt>.
;<tt>Weekday(MyDate)</tt>:returns the number of the weekday from <tt>MyDate</tt>.
;<tt>Hour(MyTime)</tt>:returns the hours from <tt>MyTime</tt>.
;<tt>Minute(MyTime)</tt>:returns the minutes from <tt>MyTime</tt>.
;<tt>Second(MyTime)</tt>:returns the seconds from <tt>MyTime</tt>.

These functions extract the date or time sections from a specified <tt>Date</tt> variable. The following example checks whether the date saved in <tt>MyDate</tt> is in the year 2003.

<source lang="oobas">
Dim MyDate As Date
' ... Initialization of MyDate

If Year(MyDate) = 2003 Then
' ... Specified date is in the year 2003
End If
</source>

In the same way, the following example checks whether <tt>MyTime</tt> is between 12 and 14 hours.

<source lang="oobas">
Dim MyTime As Date
' ... Initialization of MyTime

If Hour(MyTime) >= 12 And Hour(MyTime) < 14 Then
' ... Specified time is between 12 and 14 hours
End If
</source>

The <tt>Weekday</tt> function returns the number of the weekday for the transferred date:

<source lang="oobas">
Dim MyDate As Date
Dim MyWeekday As String
' ... initialize MyDate

Select Case WeekDay(MyDate)
case 1
MyWeekday = "Sunday"
case 2
MyWeekday = "Monday"
case 3
MyWeekday = "Tuesday"
case 4
MyWeekday = "Wednesday"
case 5
MyWeekday = "Thursday"
case 6
MyWeekday = "Friday"
case 7
MyWeekday = "Saturday"
End Select
</source>

{{Note|Sunday is considered the first day of the week.}}

== Retrieving System Date and Time ==

The following functions are available in {{OOo}} Basic to retrieve the system time and system date:

;<tt>Date</tt>:returns the present date as a string. The format depends on localization settings.
;<tt>Time</tt>:returns the present time as a string.
;<tt>Now</tt>:returns the present point in time (date and time) as a combined value of type <tt>Date</tt>.

{{PDL1}}

@@ Line 5: / Line 5: @@
 |ShowPrevNext=block
 |ShowPrevPage=block
-|PrevPage=EN/documentation/basic_guide/strings_(runtime_library)
+|PrevPage=EN/documentation/basic_guide/strings_runtime_library
-|NextPage=EN/documentation/basic_guide/files_and_directories_(runtime_library)
+|NextPage=EN/documentation/basic_guide/files_and_directories_runtime_library
 |runtime=block
 }}

← Older revision	Revision as of 16:45, 2 September 2011
(No difference)

EN/documentation/basic guide/date and time runtime library - Revision history

Sancho at 16:52, 2 September 2011

Sancho: moved EN/documentation/basic guide/date and time (runtime library) to EN/documentation/basic guide/date and time runtime library

Sancho: Основной текст