Section contents
ce32base.oxh
<TBS>
this& = NewTime&:
Creates a time object and returns a handle which allows the object to be manipulated.
width& |
The width of the size. |
height& |
The height of the size |
this& |
An value which represents the created time |
If the object could not be created then an error is generated
which should be trapped by an ONERR
handler.
LOCAL this& this& = NewTime&: DeleteTime:(this&)
this& = NewTime2&:(int64&)
Creates a time object, initialises with the int64 object int64&
and returns a handle which allows the object to be manipulated.
int64& |
A handle to an int64 object |
this& |
An value which represents the created time |
If the object could not be created then an error is generated
which should be trapped by an ONERR
handler.
this& = NewTime3&:(str$)
Creates a time object, initialises with date in the string str$
and returns a handle which allows the object to be manipulated.
str$ |
A string contingin a date |
this& |
An value which represents the created time |
If the object could not be created then an error is generated
which should be trapped by an ONERR
handler.
this& = NewTime4&:(datetime&)
Creates a time object, initialises with date and time in the
date and time object datetime&
and returns a
handle which allows the object to be manipulated.
datetime& |
A handle to a date and time object |
this& |
An value which represents the created time |
If the object could not be created then an error is generated
which should be trapped by an ONERR
handler.
DeleteTime:(this&)
Destroys the time object.
this& |
A handle to a time object |
LOCAL this& this& = NewTime&: DeleteTime:(this&)
this& = TimeAssignInt64&:(this&,int64&)
Assigns the value in the int64 object int64&
into the time object this&
.
this& |
A handle to a time object |
int64& |
A handle to an int64 object |
this& |
A handle to a time object |
this& =
TimeAssignDateTime&:(this&,datetime&)
Assigns the value in the date and time object datetime&
into the time object this&
.
this& |
A handle to a time object |
datetime& |
A handle to a date and time object |
this& |
A handle to a time object |
If the this&
object cannot be created then an
error is generated which should be trapped by an ONERR
handler.
datetime& = TimeDateTime&:(this&)
Creates and returns a date and time object.
this& |
A handle to a time object |
datetime& |
A handle to a date and time object |
num& = TimeDayNoInMonth&:(this&)
Returns the number of the day in the month.
this& |
A handle to a time object |
num& |
The number of the day in the month |
num& = TimeDayNoInWeek&:(this&)
Returns the number of the day in the week.
this& |
A handle to a time object |
num& |
The number of the day in the week |
num& =
TimeDayNoInYear&:(this&,time&,rule%)
Returns the number of the day in the year.
this& |
A handle to a time object |
time& |
A handle to a time object which is to be concidered the start of the year, or 0 for the default value of 1st January |
rule% |
<TBS> |
num& |
The number of the day in the year |
days& = TimeDaysFrom&:(this&,time&)
.Returns the difference in days between this&
and time&
.
this& |
A handle to a time object |
time& |
A handle to a time object |
days& |
The difference in days |
num& = TimeDaysInMonth&:(this&)
Returns the number of the days in the month.
this& |
A handle to a time object |
num& |
The number of the days in the month |
TimeFormat:(this&,des&,fmt$)
Write the time in text form into the descriptor des&
,
according to the format specified by the string fmt$
.
this& |
A handle to a time object |
des& |
A handle to a descriptor object |
fmt$ | A string specifying the format required |
If the time cannot be converted then an error is generated
which should be trapped by an ONERR
handler.
str$ = TimeFormatStr$:(this&,fmt$)
Write the time in text form into the descriptor des&
,
according to the format specified by the string fmt$
.
this& |
A handle to a time object |
fmt$ | A string specifying the format required |
str$ |
A string containing the required time in text format |
If the str$
string cannot be created or the time
cannot be converted then an error is generated which should be
trapped by an ONERR
handler.
TimeHomeTime:(this&)
Initialises the time to the home city time..
this& |
A handle to a time object |
err% = TimeHoursFrom%:(this&,time&,BYREF
hours&)
.Returns the difference in hours between this&
and time&
.
this& |
A handle to a time object |
time& |
A handle to a time object |
BYREF hours& |
The difference in hours |
err% |
An error code. A non-zero result indicates that the
value didn't fit into hours& |
err% = TimeMinutesFrom%:(this&,time&,BYREF
minutes&)
.Returns the difference in minutes between this&
and time&
.
this& |
A handle to a time object |
time& |
A handle to a time object |
BYREF minutes& |
The difference in minutes |
err% |
An error code. A non-zero result indicates that the
value didn't fit into minutes& |
months& = TimeMonthsFrom&:(this&,time&)
.Returns the difference in months between this&
and time&
.
this& |
A handle to a time object |
time& |
A handle to a time object |
months& |
The difference in months |
err% = TimeParse%:(this&,str$,century%)
Parses the string str$
and initialises this&
with the date and time found in the string..
this& |
A handle to a time object |
str$ |
A string |
century% |
A value between 0 an 99 which is used as the century if the year is specified using only 2 digits |
err% |
An error code |
TimeRoundUpToNextMinute:(this&)
Rounds the time up to the next minute.
this& |
A handle to a time object |
err% = TimeSecondsFrom%:(this&,time&,BYREF
seconds&)
.Returns the difference in seconds between this&
and time&
.
this& |
A handle to a time object |
time& |
A handle to a time object |
BYREF seconds& |
The difference in seconds |
err% |
An error code. A non-zero result indicates that the
value didn't fit into seconds& |
err% = TimeSet%:(this&,str$)
Set the time from the contents of the string str$
.
this& |
A handle to a time object |
str$ |
A string which contains the date |
err% |
An error code |
TimeUniversalTime:(this&)
Initialises the time to universal time..
this& |
A handle to a time object |
num& =
TimeWeekNoInYear&:(this&.start&,rule%)
Returns the week number in the year.
this& |
A handle to a time object |
start& |
A handle to a time object which specifies the start of the year, or 0 for the default of 1st January |
rule% |
The rule which specifies how to determine when the 1st week starts. |
num& |
The week number |