Provisioning XML Document for Locale Configuration Service Provider (Compact 7)

Article
03/14/2014

3/12/2014

Configuration Manager uses this XML document to configure locale-specific settings such as language, calendar type, and currency type for a Windows Embedded Compact powered device.

Syntax

<wap-provisioningdoc>
    <characteristic type="Locale">
      <parm name="<ParmName>" value="<ParmValue>" />
    <parm-query name="<ParmName>" />
  </characteristic>
</wap-provisioningdoc>

Elements

Element name	Description	Attributes
characteristic	Groups settings for a configuration service provider.	type Set to "Locale" to indicate the root characteristic element for the Locale configuration service provider.
parm	Metadata that describes a device setting.	name The name of the device setting to configure. It can be one of the following: Value Description LanguageCurrent language. When used, the corresponding value attribute indicates the current language of the UI displayed on the device. For more information, see Language Identifiers. To apply this change after provisioning, the user must restart the Windows Embedded Compact powered device. LocaleCurrent locale. When used, the corresponding value attribute indicates the current locale of the device. For more information, see Language Identifiers. LOCALE_ICALENDARTYPE Current calendar type. When used, the corresponding value attribute can be one of the following values: Value Description 1Gregorian (as in United States) 2Gregorian (English strings always) 3Era: Year of the Emperor (Japan) 4Era: Year based on the Chinese Calendar 5Tangun Era (Korea) LOCALE_ICURRDIGITSCurrency digits. When used, the corresponding value attribute indicates the number of decimal places used for the local currency format. The maximum number for value is 9. LOCALE_ICURRENCY Positive currency mode. When used, the corresponding value attribute can be one of the following: Value Description 0Prefix, no separation 1Suffix, no separation 2Prefix, 1-character separation 3Suffix, 1-character separation LOCALE_IDIGITSNumber of fractional digits. When used, the corresponding value attribute indicates the number of fractional digits for the locale. The maximum number for value is 3. LOCALE_IFIRSTDAYOFWEEK The first day in a week. When used, the corresponding value attribute can be one of the following: Value Description 0LOCALE_SDAYNAME1 (Monday) 1LOCALE_SDAYNAME2 (Tuesday) 2LOCALE_SDAYNAME3 (Wednesday) 3LOCALE_SDAYNAME4 (Thursday) 4LOCALE_SDAYNAME5 (Friday) 5LOCALE_SDAYNAME6 (Saturday) 6LOCALE_SDAYNAME7 (Sunday) LOCALE_IFIRSTWEEKOFYEAR First week of the year. When used, the corresponding value attribute can be one of the following: Value Description 0The week containing January 1 is the first week of that year. 1The first full week that follows January 1 is the first week of that year. 2The first week containing at least 4 days is the first week of that year. LOCALE_ILZERO Indicates whether leading zeros are used in decimal fields. When used, the corresponding value attribute can be one of the following: Value Description 0No leading zeros. 1Leading zeros. LOCALE_IMEASURE System of measurement. When used, the corresponding value attribute can be one of the following: Value Description 0The metric system (Systéme International d'Unités, or S.I.). 1U.S. system. LOCALE_INEGCURR Negative currency mode. When used, the corresponding value attribute can be one of the following: Value Example 0($1.1) 1-$1.1 2$-1.1 3$1.1- 4(1.1$) 5-1.1$ 61.1-$ 71.1$- 8-1.1 $ (space before $) 9-$ 1.1 (space after $) 101.1 $- (space before $) 11$ 1.1- (Space after $) 12$-1.1 (space after $) 131.1- $ (space before $) 14($ 1.1) (space after $) 15(1.1 $) (Space before $) LOCALE_INEGNUMBER Negative number mode. When used, the corresponding value attribute can be one of the following: Value Description 0(1.1) 1-1.1 2- 1.1 (space after "-") 31.1- 41.1 - (space before "-") LOCALE_IPAPERSIZE Default paper size associated with the locale.When used, the corresponding value attribute can be one of the following: Value Description 1U.S. letter 5U.S. legal 8A3 9A4 LOCALE_ITIME Time format specification. When used, the corresponding value attribute can be one of the following: Value Description 0A.M. / P.M. 12-hour format 124-hour format LOCALE_S1159The A.M. designator. When used, the corresponding value attribute indicates the string for the A.M. designator. LOCALE_S2359The P.M. designator. When used, the corresponding value attribute indicates the string for the P.M. designator. LOCALE_SCURRENCYCurrency identifier. When used, the value attribute indicates the character to identify currency. For example, "$". LOCALE_SDATEDate separator. When used, the value attribute indicates one or more characters for the date separator. LOCALE_SDECIMALDecimal separator. When used, the value attribute indicates one or more characters used as the decimal separator. LOCALE_SGROUPINGDigit grouping. When used, the value attribute indicates the number of digits to group between each separator such as a comma (,), to the left of the decimal. To group by thousands (i.e., "1,000"), specify 3;0. Use semicolons to specify sizes for digit groupings. If the last value is zero, the preceding value is repeated for each group of digits (i.e., "1,000,000"). LOCALE_SLISTThe character used to separate lists. When used, the value attribute indicates one or more characters used to separate list items. For example, a comma. LOCALE_SLONGDATELong date formatting string for this locale. When used, the corresponding value attribute is a string that can consist of a combination of strings defined in Day, Month, Year, and Era Format Pictures. It can also include a string of characters enclosed in single quotes. LOCALE_SMONDECIMALSEPCurrency decimal separator. When used, the value attribute indicates the character(s) used as the currency decimal separator. LOCALE_SMONGROUPINGCurrency digit grouping. When used, the corresponding value attribute indicates the number of currency digits to group between each separator such as a comma (,), to the left of the decimal. To group by thousands (i.e., "1,000"), specify 3;0. Use semicolons to specify sizes for digit groupings. If the last value is zero, the preceding value is repeated for each group of digits (i.e., "1,000,000"). LOCALE_SMONTHOUSANDSEPThousands currency separator. When used, the corresponding value attribute indicates one or more characters used as the currency separator between groups of digits to the left of the decimal. LOCALE_SNEGATIVESIGNNegative sign. When used, the corresponding value attribute indicates the string value for the negative sign. LOCALE_SPOSITIVESIGNPositive sign. When used, the corresponding value attribute indicates the string value for the positive sign. LOCALE_STHOUSANDThousands separator. When used, the corresponding value attribute indicates one or more characters used to separate groups of digits to the left of the decimal. LOCALE_STIMETime separator. When used, the corresponding value attribute indicates one or more characters for the time separator. LOCALE_STIMEFORMATTime formatting strings for this locale. When used, the corresponding value attribute is a string that can consist of a combination of the characters defined in Hour, Minute, and Second Format Pictures. LOCALE_SYEARMONTHThe Year/Month formatting string for the locale. When used, the corresponding value attribute is a string that shows the proper format for a date string that contains only the year and the month. SPECIAL_SCURRENCYCurrency symbol. When used, the corresponding value attribute is a string used as the local currency symbol. Value See descriptions in name attribute for possible values.
parm-query	Specifies a request for the current value of a setting.	name Any supported name attribute listed above. value On return, contains the value of the setting provided in name.

characteristic

Groups settings for a configuration service provider.

type: Set to "Locale" to indicate the root characteristic element for the Locale configuration service provider.

parm

Metadata that describes a device setting.

name: The name of the device setting to configure. It can be one of the following:

Value Description

LanguageCurrent language. When used, the corresponding value attribute indicates the current language of the UI displayed on the device. For more information, see Language Identifiers. To apply this change after provisioning, the user must restart the Windows Embedded Compact powered device.

LocaleCurrent locale. When used, the corresponding value attribute indicates the current locale of the device. For more information, see Language Identifiers.

LOCALE_ICALENDARTYPE

Current calendar type. When used, the corresponding value attribute can be one of the following values:

Value Description

1Gregorian (as in United States)

2Gregorian (English strings always)

3Era: Year of the Emperor (Japan)

4Era: Year based on the Chinese Calendar

5Tangun Era (Korea)

LOCALE_ICURRDIGITSCurrency digits. When used, the corresponding value attribute indicates the number of decimal places used for the local currency format. The maximum number for value is 9.

LOCALE_ICURRENCY

Positive currency mode. When used, the corresponding value attribute can be one of the following:

Value Description

0Prefix, no separation

1Suffix, no separation

2Prefix, 1-character separation

3Suffix, 1-character separation

LOCALE_IDIGITSNumber of fractional digits. When used, the corresponding value attribute indicates the number of fractional digits for the locale. The maximum number for value is 3.

LOCALE_IFIRSTDAYOFWEEK

The first day in a week. When used, the corresponding value attribute can be one of the following:

Value Description

0LOCALE_SDAYNAME1 (Monday)

1LOCALE_SDAYNAME2 (Tuesday)

2LOCALE_SDAYNAME3 (Wednesday)

3LOCALE_SDAYNAME4 (Thursday)

4LOCALE_SDAYNAME5 (Friday)

5LOCALE_SDAYNAME6 (Saturday)

6LOCALE_SDAYNAME7 (Sunday)

LOCALE_IFIRSTWEEKOFYEAR

First week of the year. When used, the corresponding value attribute can be one of the following:

Value Description

0The week containing January 1 is the first week of that year.

1The first full week that follows January 1 is the first week of that year.

2The first week containing at least 4 days is the first week of that year.

LOCALE_ILZERO

Indicates whether leading zeros are used in decimal fields. When used, the corresponding value attribute can be one of the following:

Value Description

0No leading zeros.

1Leading zeros.

LOCALE_IMEASURE

System of measurement. When used, the corresponding value attribute can be one of the following:

Value Description

0The metric system (Systéme International d'Unités, or S.I.).

1U.S. system.

LOCALE_INEGCURR

Negative currency mode. When used, the corresponding value attribute can be one of the following:

Value Example

0($1.1)

1-$1.1

2$-1.1

3$1.1-

4(1.1$)

5-1.1$

61.1-$

71.1$-

8-1.1 $ (space before $)

9-$ 1.1 (space after $)

101.1 $- (space before $)

11$ 1.1- (Space after $)

12$-1.1 (space after $)

131.1- $ (space before $)

14($ 1.1) (space after $)

15(1.1 $) (Space before $)

LOCALE_INEGNUMBER

Negative number mode. When used, the corresponding value attribute can be one of the following:

Value Description

0(1.1)

1-1.1

2- 1.1 (space after "-")

31.1-

41.1 - (space before "-")

LOCALE_IPAPERSIZE

Default paper size associated with the locale.When used, the corresponding value attribute can be one of the following:

Value Description

1U.S. letter

5U.S. legal

8A3

9A4

LOCALE_ITIME

Time format specification. When used, the corresponding value attribute can be one of the following:

Value Description

0A.M. / P.M. 12-hour format

124-hour format

LOCALE_S1159The A.M. designator. When used, the corresponding value attribute indicates the string for the A.M. designator.

LOCALE_S2359The P.M. designator. When used, the corresponding value attribute indicates the string for the P.M. designator.

LOCALE_SCURRENCYCurrency identifier. When used, the value attribute indicates the character to identify currency. For example, "$".

LOCALE_SDATEDate separator. When used, the value attribute indicates one or more characters for the date separator.

LOCALE_SDECIMALDecimal separator. When used, the value attribute indicates one or more characters used as the decimal separator.

LOCALE_SGROUPINGDigit grouping. When used, the value attribute indicates the number of digits to group between each separator such as a comma (,), to the left of the decimal. To group by thousands (i.e., "1,000"), specify 3;0. Use semicolons to specify sizes for digit groupings. If the last value is zero, the preceding value is repeated for each group of digits (i.e., "1,000,000").

LOCALE_SLISTThe character used to separate lists. When used, the value attribute indicates one or more characters used to separate list items. For example, a comma.

LOCALE_SLONGDATELong date formatting string for this locale. When used, the corresponding value attribute is a string that can consist of a combination of strings defined in Day, Month, Year, and Era Format Pictures. It can also include a string of characters enclosed in single quotes.

LOCALE_SMONDECIMALSEPCurrency decimal separator. When used, the value attribute indicates the character(s) used as the currency decimal separator.

LOCALE_SMONGROUPINGCurrency digit grouping. When used, the corresponding value attribute indicates the number of currency digits to group between each separator such as a comma (,), to the left of the decimal. To group by thousands (i.e., "1,000"), specify 3;0. Use semicolons to specify sizes for digit groupings. If the last value is zero, the preceding value is repeated for each group of digits (i.e., "1,000,000").

LOCALE_SMONTHOUSANDSEPThousands currency separator. When used, the corresponding value attribute indicates one or more characters used as the currency separator between groups of digits to the left of the decimal.

LOCALE_SNEGATIVESIGNNegative sign. When used, the corresponding value attribute indicates the string value for the negative sign.

LOCALE_SPOSITIVESIGNPositive sign. When used, the corresponding value attribute indicates the string value for the positive sign.

LOCALE_STHOUSANDThousands separator. When used, the corresponding value attribute indicates one or more characters used to separate groups of digits to the left of the decimal.

LOCALE_STIMETime separator. When used, the corresponding value attribute indicates one or more characters for the time separator.

LOCALE_STIMEFORMATTime formatting strings for this locale. When used, the corresponding value attribute is a string that can consist of a combination of the characters defined in Hour, Minute, and Second Format Pictures.

LOCALE_SYEARMONTHThe Year/Month formatting string for the locale. When used, the corresponding value attribute is a string that shows the proper format for a date string that contains only the year and the month.

SPECIAL_SCURRENCYCurrency symbol. When used, the corresponding value attribute is a string used as the local currency symbol.

Value: See descriptions in name attribute for possible values.

parm-query

Specifies a request for the current value of a setting.

name: Any supported name attribute listed above.

value: On return, contains the value of the setting provided in name.

Remarks

To change regional settings on the device, you can write a provisioning XML file that you customize for the Locale configuration service provider. However, the Locale configuration service provider supports only a subset of elements and its own attribute values for the characteristic and parm elements.

For more information about elements, see Provisioning XML Document.

Example

The following example configures all of the regional settings for the device, such as calendar options, measurements, date, time, currency, and numerical displays.

Important

For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.

<wap-provisioningdoc>
 <characteristic type="Locale">
   <parm name="LOCALE_ICALENDARTYPE" value="1" />
   <parm name="LOCALE_IMEASURE" value="1" />
   <parm name="LOCALE_IFIRSTDAYOFWEEK" value="6" />
   <parm name="LOCALE_IFIRSTWEEKOFYEAR" value="0" />
   <parm name="LOCALE_IPAPERSIZE" value="1" />
   <parm name="LOCALE_SLONGDATE" value="dddd, MMMM dd, yyyy" />
   <parm name="LOCALE_SPOSITIVESIGN" value="" />
   <parm name="LOCALE_SSHORTDATE" value="M/d/yy" />
   <parm name="LOCALE_STIMEFORMAT" value="h:mm:ss tt" />
   <parm name="LOCALE_SYEARMONTH" value="MMMM, yyyy" />
   <parm name="LOCALE_STIME" value=":" />
   <parm name="LOCALE_S1159" value="AM" />
   <parm name="LOCALE_S2359" value="PM" />
   <parm name="LOCALE_SDATE" value="/" />
   <parm name="LOCALE_SDECIMAL" value="." />
   <parm name="LOCALE_IDIGITS" value="2" />
   <parm name="LOCALE_STHOUSAND" value="," />
   <parm name="LOCALE_INEGNUMBER" value="1" />
   <parm name="LOCALE_SGROUPING" value="3;0" />
   <parm name="LOCALE_SLIST" value="," />
   <parm name="LOCALE_SNEGATIVESIGN" value="-" />
   <parm name="LOCALE_ILZERO" value="1" />
   <parm name="LOCALE_SCURRENCY" value="$" />
   <parm name="LOCALE_ICURRENCY" value="0" />
   <parm name="LOCALE_SMONDECIMALSEP" value="." />
   <parm name="LOCALE_ICURRDIGITS" value="2" />
   <parm name="LOCALE_SMONTHOUSANDSEP" value="," />
   <parm name="LOCALE_INEGCURR" value="0" />
   <parm name="LOCALE_SMONGROUPING" value="3;0" />
 </characteristic>
</wap-provisioningdoc>

Requirements

sysgen

SYSGEN_DMSRV,
SYSGEN_SYSCSPS_LOCALECSP

Share via

Provisioning XML Document for Locale Configuration Service Provider (Compact 7)

Syntax

Elements

Remarks

Example

Requirements

See Also

Reference

Additional resources