Section contents
ce32base.oxh
<TBS>
this& = NewLocale&:
Creates a locale object and returns a handle which allows the object to be manipulated.
this& |
An value which represents the created locale |
If the object could not be created then an error is generated
which should be trapped by an ONERR
handler.
LOCAL this& this& = NewLocale&: DeleteLocale:(this&)
DeleteLocale:(BYREF this&)
Destroys the locale object.
BYREF this& |
A handle to a locale object |
LOCAL this& this& = NewLocale&: DeleteLocale:(this&)
bool% = LocaleAmPmSpaceBefore%:(this&)
Returns TRUE(-1) if a space should be placed before the AM/PM text..
this& |
A handle to a locale object |
bool% |
TRUE(-1) is a space should be placed before the AM/PM text, otherwise FALSE(0) |
pos% = LocaleAmPmSymbolPosition%:(this&)
Get whether the am/pm text should be inserted before or after the time...
this& |
A handle to a locale object |
pos% |
The locale position |
format% = LocaleClockFormat%:(this&)
Get whether the clock is an analogue or digit clock..
this& |
A handle to a locale object |
format% |
The clock format |
code& = LocaleCountryCode&:(this&)
Returns the country code which is the international dialing code prefix.
this& |
A handle to a locale object |
code& |
The country code |
places% = LocaleCurrencyDecimalPlaces%:(this&)
Returns the number of decimal places used for currency.
this& |
A handle to a locale object |
places% |
The number of decimal places used for currency |
bool% = LocaleCurrencyNegativeInBrackets%:(this&)
Get whether negative currency values would be display in brackets.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if negative currency values
should be display in brackets, otherwise KFalse% (0) |
bool% = LocaleCurrencySpaceBetween%:(this&)
Get whether a space should be placed between the currency symbol and the value.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if space should be placed
between the currency symbol and the value, otherwise KFalse% (0) |
bool% = LocaleCurrencySymbolPosition%:(this&)
Get whether the currency symbol should be placed before or after the value.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if the currency symbol should
be placed before the value, otherwise KFalse% (0) |
bool% = LocaleCurrencyTriadsAllowed%:(this&)
Get whether the currency values should be split into groups of 3 digit nunbers.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if triads are allowed in
currency values, otherwise KFalse% (0) |
format% = LocaleDateFormat%:(this&)
Get the date format.
this& |
A handle to a locale object |
format% |
The date format |
char% = LocaleDateSeparator%:(this&,index%)
Get the date seperator index%
.
The format use is as follows:
separator[0] dateComponent1 separator[1] dateComponent2 separator[2] dateComponent3 separator[3]
this& |
A handle to a locale object |
index% |
The index of the date seperator to set. Allowable values are 0 to 3 |
char% |
The character value of the date seperator |
bool% = LocaleDaylightSaving%:(this&)
Get whether daylight saving is in effect.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if daylight saving is in
effect, otherwise KFalse% (0) |
char% = LocaleDecimalSeparator%:(this&)
Get the decimal seperator character
.
this& |
A handle to a locale object |
char% |
The character value of the decimal seperator |
zone% = LocaleHomeDaylightSavingZone%:(this&)
Get the home daylight saving zone.
this& |
A handle to a locale object |
zone% |
The home daylight saving zone |
bool% = LocaleQueryHomeDaylightSavingZone%:(this&)
Get whether the home city has a daylight saving zone.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if home has a daylight saving
zone, otherwise KFalse% (0) |
LocaleRefresh:(this&)
Refreshes the contents of the locale object this&
with the current system settings.
this& |
A handle to a locale object |
LocaleSet:(this&)
Sets the current system locale settings with the contents of
the locale object this&
.
this& |
A handle to a locale object |
LocaleSetAmPmSpaceBetween:(this&,bool%)
Set whether a space should be inserted before the am/pm text..
this& |
A handle to a locale object |
bool% |
TRUE(-1) is a space is to be inserted before the am/pm text, otherwise FALSE(0) |
LocaleSetAmPmSymbolPosition:(this&,pos%)
Set whether the am/pm text should be before or after the time.
this& |
A handle to a locale object |
pos% |
The locale position |
LocaleSetClockFormat:(this&,format%)
Set whether the clock should be analogue or digit.
this& |
A handle to a locale object |
format% |
The clock format |
LocaleSetCountryCode:(this&,code&)
Set the country code which is the international dialing code prefix.
this& |
A handle to a locale object |
code& |
The country code |
LocaleSetCurrencyDecimalPlaces:(this&,places&)
Set the number of deciaml places in a currency value.
this& |
A handle to a locale object |
places& |
The number of decimal places |
LocaleSetCurrencyNegInBrackets:(this&,bool%)
Set whether negative values should be displayed in brackets.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if negative values should be
displayed in brackets, otherwise KFalse% (0) |
LocaleSetCurrencySpaceBetween:(this&,bool%)
Set whether a space should be inserted between the currency symbol and the value.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if a space should be
displayed between the currency symbol and value,
otherwise KFalse% (0) |
LocaleSetCurrencySymbolPosition:(this&,bool%)
Set whether the currency symbol should be inserted before or after the value.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if the currency symbol should
be display before the value, otherwise KFalse% (0) |
LocaleSetCurrencyTriadsAllowed:(this&,bool%)
Set whether triads are allowed in currency values.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if triads are allowed in
currency values, otherwise KFalse% (0) |
LocaleSetDateFormat:(this&,format%)
Set the date format.
this& |
A handle to a locale object |
format% |
The date format |
LocaleSetDateSeparator&:(this&,char%,index%)
Set the date seperator index%
with the character char%
.
The format use is as follows:
separator[0] dateComponent1 separator[1] dateComponent2 separator[2] dateComponent3 separator[3]
this& |
A handle to a locale object |
char% |
The character value to set the date seperator |
index% |
The index of the date seperator to set. Allowable values are 0 to 3 |
LocaleSetDaylightSaving:(this&,bool%)
Set whether daylight saving is in effect.
this& |
A handle to a locale object |
bool% |
KTrue% (-1) if daylight saving is in
effect, otherwise KFalse% (0) |
LocaleSetDecimalSeparator:(this&,char%)
Set the decimal separator with the character char%
.
this& |
A handle to a locale object |
char% |
The character value to set the decimal seperator |
LocaleSetHomeDaylightSavingZone:(this&,zone&)
Set the home daylight saving zone.
this& |
A handle to a locale object |
zone& |
The daylight saving zone |
LocaleSetStartOfWeek:(this&,day%)
Set the day of the week which is to be concidered the start of a week.
this& |
A handle to a locale object |
day% |
A day of the week |
LocaleSetThousandsSeparator:(this&,char%)
Set the thousands separator with the character char%
.
this& |
A handle to a locale object |
char% |
The character value to set as the thousands separator |
LocaleSetTimeFormat:(this&,format%)
Set the thousands separator with the character char%
.
this& |
A handle to a locale object |
char% |
The character value to set as the thousands separator |
LocaleSetTimeSeparator&:(this&,char%,index%)
Set the time separator index%
with the character char%
.
The format use is as follows:
separator[0] hour separator[1] minute separator[2] seconds separator[3]
this& |
A handle to a locale object |
char% |
The character value to set the time seperator |
index% |
The index of the date seperator to set. Allowable values are 0 to 3 |
LocaleSetUnitsDistanceLong:(this&,units%)
Set the units used for long distances..
this& |
A handle to a locale object |
units% |
The units to use for long distances |
LocaleSetUnitsDistanceShort:(this&,units%)
Set the units used for short distances..
this& |
A handle to a locale object |
units% |
The units to use for short distances |
LocaleSetUnitsGeneral:(this&,units%)
Set the units used for units..
this& |
A handle to a locale object |
units% |
The units to use |
LocaleSetWorkDays:(this&,mask%)
Set the days of the week that are to be concidered work days..
this& |
A handle to a locale object |
mask% |
A mask which contains a set bit for each day of the week which is a work day |
day% = LocaleStartOfWeek%:(this&)
Get the day of the week that is to be concidered the first day of the week.
this& |
A handle to a locale object |
day% |
A day of the week |
char% = LocaleTimeSeparator%:(this&,index%)
Set the time separator index%
with the character char%
.
The format use is as follows:
separator[0] hours separator[1] minutes separator[2] second separator[3]
this& |
A handle to a locale object |
index% |
The index of the time seperator to set. Allowable values are 0 to 3 |
char% |
The character value of the time separator |
char% = LocaleThousandsSeparator%:(this&)
Get the thousands separator character.
this& |
A handle to a locale object |
char% |
The character value of the thousand separator |
units% = LocaleUnitsDistanceLong%:(this&)
Get the units to be used for long distances.
this& |
A handle to a locale object |
units% |
The units of measurement |
units% = LocaleUnitsDistanceShort%:(this&)
Get the units to be used for short distances.
this& |
A handle to a locale object |
units% |
The units of measurement |
units% = LocaleUnitsGeneral%:(this&)
Get the units to be used for measurements.
this& |
A handle to a locale object |
units% |
The units of measurement |
mask% = LocaleWorkDays%:(this&)
Get the days of the week that are to be concidered work days..
this& |
A handle to a locale object |
mask% |
A mask which contains a set bit for each day of the week which is a work day |