4D v14.3

GET SYSTEM FORMAT

Home

 
4D v14.3
GET SYSTEM FORMAT

GET SYSTEM FORMAT 


 

GET SYSTEM FORMAT ( format ; value ) 
Parameter Type   Description
format  Longint in System format to be retrieved
value  String in Value of format defined in the system

The GET SYSTEM FORMAT command returns the current value of several regional parameters defined in the operating system. This command can be used to build “automatic” custom formats based on the system preferences.

In the format parameter, pass the type of parameter whose value you want to know. The result is returned directly by the system in the value parameter as a character string. In format, you must pass one of the following constants of the System Format theme. Below is a description of these constants:

Constant Type Value Comment
Currency symbol Longint 2 Currency symbol (e.g.: “$”)
Date separator Longint 13 Separator used in date formats (e.g.: “/”)
Decimal separator Longint 0 Decimal separator (e.g.: “.”)
Short date day position Longint 15 Position of the day in the short date format: “1” = left, “2” = middle, “3” = right
Short date month position Longint 16 Position of the month in the short date format: “1” = left, “2” = middle, “3” = right
Short date year position Longint 17 Position of the year in the short date format: “1” = left, “2” = middle, “3” = right
System date long pattern Longint 8 Long date display format in the form “dddd MMMM yyyy”
System date medium pattern Longint 7 Medium date display format in the form “dddd MMMM yyyy”
System date short pattern Longint 6 Short date display format in the form “dddd MMMM yyyy”
System time AM label Longint 18 Additional label for a time before noon in 12-hour formats (e.g.: “Morning”)
System time long pattern Longint 5 Long time display format in the form “HH:MM:SS”
System time medium pattern Longint 4 Medium time display format in the form “HH:MM:SS”
System time PM label Longint 19 Additional label for a time after noon in 12-hour formats (e.g.: “Afternoon”)
System time short pattern Longint 3 Short time display format in the form “HH:MM:SS”
Thousand separator Longint 1 Thousand separator (e.g.: “,”)
Time separator Longint 14 Separator used in time formats (e.g.: “:”)

Example  

On a check that is filled in mechanically, the amounts written are generally prefixed by “*” characters in order to prevent fraud. If the standard system display format for currency is “$ 5,422.33”, the format for checks should be of the type “$***5432.33”: no comma after the thousand digit and no space between the $ symbol and the first number. The format to be used with the String function must be “$*******.**”. To build it via programming, it is necessary to know the currency symbol and the decimal separator:

 GET SYSTEM FORMAT(Currency symbol;$vCurrSymb)
 GET SYSTEM FORMAT(Decimal separator;$vDecSep)
 $MyFormat:="###"+$vCurrSymb+"*******"+$vDecSep+"**"
 $Result:=String(amount;$MyFormat)

 
PROPERTIES 

Product: 4D
Theme: System Environment
Number: 994

 
HISTORY 

Created: 4D v11 SQL

 
SEE ALSO 

OBJECT SET FORMAT

 
ARTICLE USAGE

4D Language Reference ( 4D v11 SQL Release 6)
4D Language Reference ( 4D v12.4)
4D Language Reference ( 4D v14 R3)
4D Language Reference ( 4D v14 R2)
4D Language Reference ( 4D v13.5)
4D Language Reference ( 4D v14.3)
4D Language Reference ( 4D v14 R4)