GetLocaleInfo Method (WINDOW)
9.5A, PLBCMP GUI Only
The GetLocalInfo method allows a user application to retrieve the current luser or system locale settings for a workstation. The method uses the following format:
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A WINDOW object that is accessed.
return
Optional. A Character String Variable that receives the requested information for the locale type.
type
Required. A decimal number or Numeric Variable that specifies the type of locale data to be retrieved.
flags
Optional. A decimal number or Numeric Variable that specifies a bit mask value to control the behavior of the method.
Flags Affected: EOS, OVER, ZERO
Note the following:
The EOS flag is set to TRUE if the {return} variable is to small to receive all of the data without being truncated.
The {flags} value is a bit mask whose bit settings define special behaviors for executing the GetLocaleInfo method. The bit mask definitions are described as follows:
|
Value |
Behavior ... |
|
0 |
Retrieve the locale data defined as 'LOCALE_USER_DEFAULT'. |
|
1 |
Specifies that the locale data is to be retrieved for the 'LOCALE_SYSTEM_DEFAULT' data set. |
The allowed values to identify the type of locale data retrieved are defined as follows. These values are described in the Microsoft MSDN documentation for the 'GetLocaleInfo' API. Also, PL/B INTEGER values of these types have been included in the 'plbmeth.inc' include file with a simple comment about the type value. By default, all of the data retreived is returned as a character string by the execution of the OS GetLocaleInfo API.
|
Constant |
Value |
|
LOCALE_ILANGUAGE |
0x1 |
|
LOCALE_SLANGUAGE |
0x2 |
|
LOCALE_SABBREVLANGNAME |
0x3 |
|
LOCALE_SNATIVELANGNAME |
0x4 |
|
|
|
|
LOCALE_ICOUNTRY |
0x5 |
|
LOCALE_SCOUNTRY |
0x6 |
|
LOCALE_SENGCOUNTRY |
0x1002 |
|
LOCALE_SABBREVCTRYNAME |
0x7 |
|
LOCALE_SNATIVECTRYNAME |
0x8 |
|
LOCALE_IGEOID |
0x5B |
|
|
|
|
LOCALE_IDEFAULTLANGUAGE |
0x9 |
|
LOCALE_IDEFAULTCOUNTRY |
0xA |
|
LOCALE_IDEFAULTCODEPAGE |
0xB |
|
LOCALE_IDEFAULTANSICODEPAGE |
0x1004 |
|
LOCALE_IDEFAULTMACCODEPAGE |
0x1011 |
|
|
|
|
LOCALE_SLIST |
0xC |
|
LOCALE_IMEASURE |
0xD |
|
LOCALE_SDECIMAL |
0xE |
|
LOCALE_STHOUSAND |
0xF |
|
LOCALE_SGROUPING |
0x10 |
|
LOCALE_IDIGITS |
0x11 |
|
LOCALE_ILZERO |
0x12 |
|
LOCALE_INEGNUMBER |
0x1010 |
|
LOCALE_SNATIVEDIGITS |
0x13 |
|
|
|
|
LOCALE_SCURRENCY |
0x14 |
|
LOCALE_SINTLSYMBOL |
0x15 |
|
LOCALE_SMONDECIMALSEP |
0x16 |
|
LOCALE_SMONTHOUSANDSEP |
0x17 |
|
LOCALE_SMONGROUPING |
0x18 |
|
LOCALE_ICURRDIGITS |
0x19 |
|
LOCALE_IINTLCURRDIGITS |
0x1A |
|
LOCALE_ICURRENCY |
0x1B |
|
LOCALE_INEGCURR |
0x1C |
|
|
|
|
LOCALE_SDATE |
0x1D |
|
LOCALE_STIME |
0x1E |
|
LOCALE_SSHORTDATE |
0x1F |
|
LOCALE_SLONGDATE |
0x20 |
|
LOCALE_STIMEFORMAT |
0x1003 |
|
LOCALE_IDATE |
0x21 |
|
LOCALE_ILDATE |
0x22 |
|
LOCALE_ITIME |
0x23 |
|
LOCALE_ITIMEMARKPOSN |
0x1005 |
|
LOCALE_ICENTURY |
0x24 |
|
LOCALE_ITLZERO |
0x25 |
|
LOCALE_IDAYLZERO |
0x26 |
|
LOCALE_IMONLZERO |
0x27 |
|
LOCALE_S1159 |
0x28 |
|
LOCALE_S2359 |
0x29 |
|
|
|
|
LOCALE_ICALENDARTYPE |
0x1009 |
|
LOCALE_IOPTIONALCALENDAR |
0x100B |
|
LOCALE_IFIRSTDAYOFWEEK |
0x100C |
|
LOCALE_IFIRSTWEEKOFYEAR |
0x100D |
|
|
|
|
LOCALE_SDAYNAME1 |
0x2A |
|
LOCALE_SDAYNAME2 |
0x2B |
|
LOCALE_SDAYNAME3 |
0x2C |
|
LOCALE_SDAYNAME4 |
0x2D |
|
LOCALE_SDAYNAME5 |
0x2E |
|
LOCALE_SDAYNAME6 |
0x2F |
|
LOCALE_SDAYNAME7 |
0x30 |
|
LOCALE_SABBREVDAYNAME1 |
0x31 |
|
LOCALE_SABBREVDAYNAME2 |
0x32 |
|
LOCALE_SABBREVDAYNAME3 |
0x33 |
|
LOCALE_SABBREVDAYNAME4 |
0x34 |
|
LOCALE_SABBREVDAYNAME5 |
0x35 |
|
LOCALE_SABBREVDAYNAME6 |
0x36 |
|
LOCALE_SABBREVDAYNAME7 |
0x37 |
|
LOCALE_SMONTHNAME1 |
0x38 |
|
LOCALE_SMONTHNAME2 |
0x39 |
|
LOCALE_SMONTHNAME3 |
0x3A |
|
LOCALE_SMONTHNAME4 |
0x3B |
|
LOCALE_SMONTHNAME5 |
0x3C |
|
LOCALE_SMONTHNAME6 |
0x3D |
|
LOCALE_SMONTHNAME7 |
0x3E |
|
LOCALE_SMONTHNAME8 |
0x3F |
|
LOCALE_SMONTHNAME9 |
0x40 |
|
LOCALE_SMONTHNAME10 |
0x41 |
|
LOCALE_SMONTHNAME11 |
0x42 |
|
LOCALE_SMONTHNAME12 |
0x43 |
|
LOCALE_SMONTHNAME13 |
0x100E |
|
LOCALE_SABBREVMONTHNAME1 |
0x44 |
|
LOCALE_SABBREVMONTHNAME2 |
0x45 |
|
LOCALE_SABBREVMONTHNAME3 |
0x46 |
|
LOCALE_SABBREVMONTHNAME4 |
0x47 |
|
LOCALE_SABBREVMONTHNAME5 |
0x48 |
|
LOCALE_SABBREVMONTHNAME6 |
0x49 |
|
LOCALE_SABBREVMONTHNAME7 |
0x4A |
|
LOCALE_SABBREVMONTHNAME8 |
0x4B |
|
LOCALE_SABBREVMONTHNAME9 |
0x4C |
|
LOCALE_SABBREVMONTHNAME10 |
0x4D |
|
LOCALE_SABBREVMONTHNAME11 |
0x4E |
|
LOCALE_SABBREVMONTHNAME12 |
0x4F |
|
LOCALE_SABBREVMONTHNAME13 |
0x100F |
|
|
|
|
LOCALE_SPOSITIVESIGN |
0x50 |
|
LOCALE_SNEGATIVESIGN |
0x51 |
|
LOCALE_IPOSSIGNPOSN |
0x52 |
|
LOCALE_INEGSIGNPOSN |
0x53 |
|
LOCALE_IPOSSYMPRECEDES |
0x54 |
|
LOCALE_IPOSSEPBYSPACE |
0x55 |
|
LOCALE_INEGSYMPRECEDES |
0x56 |
|
LOCALE_INEGSEPBYSPACE |
0x57 |
The following require WINVER >= 0x400 (Windows 2000 and higher)
|
Constant |
Value |
|
LOCALE_ILANGUAGE |
0x1 |
|
LOCALE_FONTSIGNATURE |
0x58 |
|
LOCALE_SISO639LANGNAME |
0x59 |
|
LOCALE_SISO3166CTRYNAME |
0x5A |
The following require WINVER >= 0x500 (Windows XP and higher)
|
Constant |
Value |
|
LOCALE_ILANGUAGE |
0x1 |
|
LOCALE_IDEFAULTEBCDICCODEPAGE |
0x1012 |
|
LOCALE_IPAPERSIZE |
0x100A |
|
LOCALE_SENGCURRNAME |
0x1007 |
|
LOCALE_SNATIVECURRNAME |
0x1008 |
|
LOCALE_SYEARMONTH |
0x1006 |
|
LOCALE_SSORTNAME |
0x1013 |
|
LOCALE_IDIGITSUBSTITUTION |
0x1014 |
The following require WINVER >= 0x600 (Windows Vista and higher)
|
Constant |
Value |
|
LOCALE_SNAME |
0x5c |
|
LOCALE_SDURATION |
0x5d |
|
LOCALE_SKEYBOARDSTOINSTALL |
0x5e |
|
LOCALE_SSHORTESTDAYNAME1 |
0x60 |
|
LOCALE_SSHORTESTDAYNAME2 |
0x61 |
|
LOCALE_SSHORTESTDAYNAME3 |
0x62 |
|
LOCALE_SSHORTESTDAYNAME4 |
0x63 |
|
LOCALE_SSHORTESTDAYNAME5 |
0x64 |
|
LOCALE_SSHORTESTDAYNAME6 |
0x65 |
|
LOCALE_SSHORTESTDAYNAME7 |
0x66 |
|
LOCALE_SISO639LANGNAME2 |
0x67 |
|
LOCALE_SISO3166CTRYNAME2 |
0x68 |
|
LOCALE_SNAN |
0x69 |
|
LOCALE_SPOSINFINITY |
0x6a |
|
LOCALE_SNEGINFINITY |
0x6b |
|
LOCALE_SSCRIPTS |
0x6c |
|
LOCALE_SPARENT |
0x6d |
|
LOCALE_SCONSOLEFALLBACKNAME |
0x6e |
|
LOCALE_SLANGDISPLAYNAME |
0x6f |
See Also: Method Syntax, WINDOW Methods
|
|