-
Notifications
You must be signed in to change notification settings - Fork 9
Get LocalizedData
Gets language-specific data into scripts and functions based on the UI culture that is specified or that is selected for the operating system.
Get-LocalizedData [[-BindingVariable] <String>] [[-UICulture] <String>] [-BaseDirectory <String>]
[-FileName <String>] [-SupportedCommand <String[]>] [[-DefaultUICulture] <String>]
[<CommonParameters>]
The Get-LocalizedData command dynamically retrieves strings from a subdirectory whose name matches the UI language set for the current user of the operating system. It is designed to enable scripts to display user messages in the UI language selected by the current user.
Optionally the Get-LocalizedData saves the hash table in the variable
that is specified by the value of the BindingVariable parameter.
Get-LocalizedData imports data from .psd1 files in language-specific subdirectories of the script directory and saves them in a local variable that is specified in the command. The command selects the subdirectory and file based on the value of the $PSUICulture automatic variable. When you use the local variable in the script to display a user message, the message appears in the user's UI language.
You can use the parameters of G-LocalizedData to specify an alternate UI culture, path, and file name, to add supported commands, and to suppress the error message that appears if the .psd1 files are not found.
The G-LocalizedData command supports the script internationalization initiative that was introduced in Windows PowerShell 2.0. This initiative aims to better serve users worldwide by making it easy for scripts to display user messages in the UI language of the current user. For more information about this and about the format of the .psd1 files, see about_Script_Internationalization.
graph LR
Argument{Parameter set?} -->|"Only UICulture
(DefaultUICulture = en-US)"| UseUIC
Argument -->|"Only DefaultUICulture"| GetUIC[\[Get OS Culture]\]
GetUIC --> LCID127{"Is LCID = 127?<br>(in variant culture)"}
Argument -->|"Both UICulture and
DefaultUICulture"| UseUIC
UseUIC[Use UICulture] --> LCID127
LCID127 -->|"No"| SetUIC[\[Set UICulture]\]
LCID127 -->|"Yes"| UseDC[Use default culture]
UseDC --> SetUIC
SetUIC --> SearchFile[\[Find UICulture<br>localization file]\]
SearchFile --> FileExist
FileExist{localization<br>file exist?} -->|"No"| ParentCulture{Parent culture<br>exist?}
ParentCulture -->|"Yes"| UseParentC[Use parent culture]
UseParentC --> SetUIC
ParentCulture -->|"No"| EvalDefaultC{Evaluate<br>default>br>culture?}
EvalDefaultC -->|"Yes"| UseDC
EvalDefaultC -->|"No"| EvalStillLCID127{Still invariant?}
FileExist -->|"Yes"| EvalStillLCID127
EvalStillLCID127 -->|"Yes, Use Get-LocalizedDataForInvariantCulture"| GetFile[\[Get localization strings]\]
EvalStillLCID127 -->|"No, Use Import-LocalizedData"| GetFile
$script:localizedData = Get-LocalizedData
Imports the localized strings for the current OS UI culture. If the localized folder does not exist then the localized strings for the default UI culture 'en-US' is returned.
$script:localizedData = Get-LocalizedData -DefaultUICulture 'de-DE'
Imports the localized strings for the current OS UI culture. If the localized folder does not exist then the localized strings for the default UI culture 'de-DE' is returned.
$script:localizedData = Get-LocalizedData -UICulture 'de-DE'
Imports the localized strings for UI culture 'de-DE'. If the localized folder does not exist then the localized strings for the default UI culture 'en-US' is returned.
$script:localizedData = Get-LocalizedData -UICulture 'de-DE' -DefaultUICulture 'en-GB'
Imports the localized strings for UI culture 'de-DE'. If the localized folder does not exist then the localized strings for the default UI culture 'en-GB' is returned.
Specifies the base directory where the .psd1 files are located. The default is the directory where the script is located. Import-LocalizedData searches for the .psd1 file for the script in a language-specific subdirectory of the base directory.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the variable into which the text strings are imported. Enter a variable name without a dollar sign ($).
In Windows PowerShell 2.0, this parameter is required. In Windows PowerShell 3.0, this parameter is optional. If you omit this parameter, Import-LocalizedData returns a hash table of the text strings. The hash table is passed down the pipeline or displayed at the command line.
When using Import-LocalizedData to replace default text strings specified in the DATA section of a script, assign the DATA section to a variable and enter the name of the DATA section variable in the value of the BindingVariable parameter. Then, when Import-LocalizedData saves the imported content in the BindingVariable, the imported data will replace the default text strings. If you are not specifying default text strings, you can select any variable name.
If the BindingVariable parameter is not specified, Import-LocalizedData returns a hashtable of the text strings. The hash table is passed down the pipeline or displayed at the command line.
Type: String
Parameter Sets: (All)
Aliases: Variable
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies which UICulture to default to if current UI culture or its parents culture don't have matching data file.
For example, if you have a data file in 'en-US' but not in 'en' or 'en-GB' and your current culture is 'en-GB', you can default back to 'en-US'.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: En-US
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the name of the data file (.psd1) to be imported. Enter a file name. You can specify a file name that does not include its .psd1 file name extension, or you can specify the file name including the .psd1 file name extension.
The FileName parameter is required when Import-LocalizedData is not used in a script. Otherwise, the parameter is optional and the default value is the base name of the script. You can use this parameter to direct Import-LocalizedData to search for a different .psd1 file.
For example, if the FileName is omitted and the script name is FindFiles.ps1, Import-LocalizedData searches for the FindFiles.psd1 data file.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies cmdlets and functions that generate only data.
Use this parameter to include cmdlets and functions that you have written or tested. For more information, see about_Script_Internationalization.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies an alternate UI culture. The default is the value of the $PsUICulture automatic variable. Enter a UI culture in - format, such as en-US, de-DE, or ar-SA.
The value of the UICulture parameter determines the language-specific subdirectory (within the base directory) from which Import-LocalizedData gets the .psd1 file for the script.
The command searches for a subdirectory with the same name as the value of the UICulture parameter or the $PsUICulture automatic variable, such as de-DE or ar-SA. If it cannot find the directory, or the directory does not contain a .psd1 file for the script, it searches for a subdirectory with the name of the language code, such as de or ar. If it cannot find the subdirectory or .psd1 file, the command fails and the data is displayed in the default language specified in the script.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Before using Import-LocalizedData, localize your user messages. Format the messages for each locale (UI culture) in a hash table of key/value pairs, and save the hash table in a file with the same name as the script and a .psd1 file name extension. Create a directory under the script directory for each supported UI culture, and then save the .psd1 file for each UI culture in the directory with the UI culture name.
For example, localize your user messages for the de-DE locale and format them in a hash table. Save the hash table in a .psd1 file. Then create a de-DE subdirectory under the script directory, and save the de-DE .psd1 file in the de-DE subdirectory. Repeat this method for each locale that you support.
Import-LocalizedData performs a structured search for the localized user messages for a script.
Import-LocalizedData begins the search in the directory where the script file is located (or the value of the BaseDirectory parameter). It then searches within the base directory for a subdirectory with the same name as the value of the $PsUICulture variable (or the value of the UICulture parameter), such as de-DE or ar-SA. Then, it searches in that subdirectory for a .psd1 file with the same name as the script (or the value of the FileName parameter).
If Import-LocalizedData cannot find a subdirectory with the name of the UI culture, or the subdirectory does not contain a .psd1 file for the script, it searches for a .psd1 file for the script in a subdirectory with the name of the language code, such as de or ar. If it cannot find the subdirectory or .psd1 file, the command fails, the data is displayed in the default language in the script, and an error message is displayed explaining that the data could not be imported. To suppress the message and fail gracefully, use the ErrorAction common parameter with a value of SilentlyContinue.
If Import-LocalizedData finds the subdirectory and the .psd1 file, it imports the hash table of user messages into the value of the BindingVariable parameter in the command. Then, when you display a message from the hash table in the variable, the localized message is displayed.
For more information, see about_Script_Internationalization.
This command should preferably be used at the top of each resource PowerShell module script file (.psm1).
It will automatically look for a file in the folder for the current UI culture, or default to the UI culture folder 'en-US'.
The localized strings file can be named either <ScriptFileName>.psd1,
e.g.
DSC_MyResource.psd1, or suffixed with strings, e.g.
DSC_MyResource.strings.psd1.
Read more about localization in the section Localization in the DSC Community style guideline.
- Assert-BoundParameter
- Assert-ElevatedUser
- Assert-IPAddress
- Assert-Module
- Compare-DscParameterState
- Compare-ResourcePropertyState
- ConvertFrom-DscResourceInstance
- ConvertTo-CimInstance
- ConvertTo-HashTable
- Find-Certificate
- Get-ComputerName
- Get-DscProperty
- Get-EnvironmentVariable
- Get-LocalizedData
- Get-LocalizedDataForInvariantCulture
- Get-PSModulePath
- Get-TemporaryFolder
- Get-UserName
- New-ArgumentException
- New-ErrorRecord
- New-Exception
- New-InvalidDataException
- New-InvalidOperationException
- New-InvalidResultException
- New-NotImplementedException
- New-ObjectNotFoundException
- Remove-CommonParameter
- Set-DscMachineRebootRequired
- Set-PSModulePath
- Test-AccountRequirePassword
- Test-DscParameterState
- Test-DscProperty
- Test-IsNanoServer
- Test-IsNumericType
- Test-ModuleExist