<cfx_kmLocale> cfx_kmSuite
Programming Reference

cfx_kmLocale contains functions related to the server operating system LOCALE settings.

CurrencyDecimals
CurrencyFormat
CurrencyString
DateSeparator
DayNames
DecimalSeparator
Help
ListSeparator
LongDateFormat
LongTimeFormat
MonthNames
NegCurrFormat
ShortDateFormat
ShortDayNames
ShortMonthNames
ShortTimeFormat
ThousandSeparator
TimeAMString
TimePMString
TimeSeparator
Version


F=CurrencyDecimals

Description
The number of digits to the right of the decimal point in a currency amount, from LOCALE_ICURRDIGITS.
Returns
The number of digits.

Syntax
  <cfx_kmLocale  F=CurrencyDecimals  V=variable  SHOW>
Examples

<cfx_kmLocale F=CurrencyDecimals>
Result:  2



F=CurrencyFormat

Description
The currency symbol placement and separation, from LOCALE_ICURRENCY.

Possible values are:
    0 = $1
    1 = 1$
    2 = $ 1
    3 = 1 $
Returns
Numeric format code.

Syntax
  <cfx_kmLocale  F=CurrencyFormat  V=variable  SHOW>
Examples

<cfx_kmLocale F=CurrencyFormat>
Result:  0



F=CurrencyString

Description
The currency symbol (or characters), from LOCALE_SCURRENCY.
Returns
The current symbol or characters.

Syntax
  <cfx_kmLocale  F=CurrencyString  V=variable  SHOW>
Examples

<cfx_kmLocale F=CurrencyString>
Result:  $



F=DateSeparator

Description
Get the date-separator for the locale language setting on the server.
Returns
Date separator character.

Syntax
  <cfx_kmLocale  F=DateSeparator  V=variable  SHOW>
Examples

<cfx_kmLocale F=DateSeparator>
Result:  /



F=DayNames

Description
Get the full names of the days of the week, in the locale-specific language set on the server.
Returns
Comma-separated list of names.

Syntax
  <cfx_kmLocale  F=DayNames  V=variable  SHOW>
Examples

<cfx_kmLocale F=DayNames>
Result:  Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday



F=DecimalSeparator

Description
The character used to separate the integer part from the fractional part of a number, from LOCALE_SDECIMAL.
Returns
Decimal separator character.

Syntax
  <cfx_kmLocale  F=DecimalSeparator  V=variable  SHOW>
Examples

<cfx_kmLocale F=DecimalSeparator>
Result:  .



F=ListSeparator

Description
The character used to separate items in a list, from LOCALE_SLIST.
Returns
List separator character.

Syntax
  <cfx_kmLocale  F=ListSeparator  V=variable  SHOW>
Examples

<cfx_kmLocale F=ListSeparator>
Result:  ,



F=LongDateFormat

Description
TThe format string used to convert a date value to a long string, from LOCALE_SLONGDATE.
Returns
Format string code.

Syntax
  <cfx_kmLocale  F=LongDateFormat  V=variable  SHOW>
Examples

<cfx_kmLocale F=LongDateFormat>
Result:  dddd, MMMM dd, yyyy



F=LongTimeFormat

Description
The format string used to convert a time value to a long string, from LOCALE_ITIME and LOCALE_ITLZERO.
Returns
Format string code.

Syntax
  <cfx_kmLocale  F=LongTimeFormat  V=variable  SHOW>
Examples

<cfx_kmLocale F=LongTimeFormat>
Result:  h:mm:ss AMPM



F=MonthNames

Description
Get the full names of the months of the year, in the locale-specific language set on the server.
Returns
Comma-separated list of names.

Syntax
  <cfx_kmLocale  F=MonthNames  V=variable  SHOW>
Examples

<cfx_kmLocale F=MonthNames>
Result:  January,February,March,April,May,June,July,August,September,October,November,December



F=NegCurrFormat

Description
Defines the currency format for negative values, from LOCALE_INEGCURR.

Possible values are:
 0 = ($1) 4 = (1$) 8 = -1 $  12 = $ -1
 1 = -$1  5 = -1$  9 = -$ 1  13 = 1- $
 2 = $-1  6 = 1-$  10 = 1 $- 14 = ($ 1)
 3 = $1-  7 = 1$-  11 = $ 1- 15 = (1 $)
Returns
Numeric format code.

Syntax
  <cfx_kmLocale  F=NegCurrFormat  V=variable  SHOW>
Examples

<cfx_kmLocale F=NegCurrFormat>
Result:  0



F=ShortDateFormat

Description
The format string used to convert a date value to a short display format, from LOCALE_SSHORTDATE.
Returns
Format string.

Syntax
  <cfx_kmLocale  F=ShortDateFormat  V=variable  SHOW>
Examples

<cfx_kmLocale F=ShortDateFormat>
Result:  M/d/yyyy



F=ShortDayNames

Description
Get the short names of the days of the week, in the locale-specific language set on the server.
Returns
Comma-separated list of names.

Syntax
  <cfx_kmLocale  F=ShortDayNames  V=variable  SHOW>
Examples

<cfx_kmLocale F=ShortDayNames>
Result:  Sun,Mon,Tue,Wed,Thu,Fri,Sat



F=ShortMonthNames

Description
Get the short names of the months of the year, in the locale-specific language set on the server.
Returns
Comma-separated list of names.

Syntax
  <cfx_kmLocale  F=ShortMonthNames  V=variable  SHOW>
Examples

<cfx_kmLocale F=ShortMonthNames>
Result:  Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec



F=ShortTimeFormat

Description
The format string used to convert a time value to a short display format, from LOCALE_ITIME and LOCALE_ITLZERO.
Returns
Format string.

Syntax
  <cfx_kmLocale  F=ShortTimeFormat  V=variable  SHOW>
Examples

<cfx_kmLocale F=ShortTimeFormat>
Result:  h:mm AMPM



F=ThousandSeparator

Description
The character used to separate thousands in numbers with more than three digits to the left of the decimal separator, from LOCALE_STHOUSAND.
Returns
Thousand separator character.

Syntax
  <cfx_kmLocale  F=ThousandSeparator  V=variable  SHOW>
Examples

<cfx_kmLocale F=ThousandSeparator>
Result:  ,



F=TimeAMString

Description
The suffix string used for time values between 00:00 and 11:59 in 12-hour clock format, from LOCALE_S1159.
Returns
Time suffix string.

Syntax
  <cfx_kmLocale  F=TimeAMString  V=variable  SHOW>
Examples

<cfx_kmLocale F=TimeAMString>
Result:  AM



F=TimePMString

Description
The suffix string used for time values between 12:00 and 23:59 in 12-hour clock format, from LOCALE_S2359.
Returns
Time suffix string.

Syntax
  <cfx_kmLocale  F=TimePMString  V=variable  SHOW>
Examples

<cfx_kmLocale F=TimePMString>
Result:  PM



F=TimeSeparator

Description
The character used to separate the hour, minute, and second parts of a time value, from LOCALE_STIME.
Returns
Time separator character.

Syntax
  <cfx_kmLocale  F=TimeSeparator  V=variable  SHOW>
Examples

<cfx_kmLocale F=TimeSeparator>
Result:  :