Ticket #2739: _WinAPI_SetLocaleInfo.txt

File _WinAPI_SetLocaleInfo.txt, 1.1 KB (added by mLipok, 11 years ago)
Line 
1###User Defined Function###
2_WinAPI_SetLocaleInfo
3
4###Description###
5Sets an item of information in the user override portion of the current locale
6
7###Syntax###
8#include <WinAPILocale.au3>
9_WinAPI_SetLocaleInfo ( $iLCID, $iType, $sData )
10
11
12###Parameters###
13@@ParamTable@@
14$iLCID
15        The locale identifier (LCID) that specifies the locale or one of the following predefined values.
16        $LOCALE_INVARIANT
17        $LOCALE_SYSTEM_DEFAULT
18        $LOCALE_USER_DEFAULT
19
20        <strong>Windows Vista or later</strong>
21        $LOCALE_CUSTOM_DEFAULT
22        $LOCALE_CUSTOM_UI_DEFAULT
23        $LOCALE_CUSTOM_UNSPECIFIED
24$iType
25        Type of locale information to set. This parameter can be one of the locale information constants ($LOCALE_*).
26$sData
27        The string containing the locale information to set. The information must be in the format specific to
28        the specified constant.
29@@End@@
30
31###ReturnValue###
32@@ReturnTable@@
33Success:        True
34Failure:        False
35@@End@@
36
37
38###Remarks###
39$LOCALE_* constants require #include <APILocaleConstants.au3>.
40
41
42###Related###
43None.
44
45
46###See Also###
47@@MsdnLink@@ SetLocaleInfo
48
49
50###Example###
51@@IncludeExample@@