Import-LocalizedData

Sintaxe

Import-LocalizedData
      [[-BindingVariable] <String>]
      [[-UICulture] <String>]
      [-BaseDirectory <String>]
      [-FileName <String>]
      [-SupportedCommand <String[]>]
      [<CommonParameters>]

Description

O Import-LocalizedData cmdlet recupera dinamicamente cadeias de caracteres de um subdiretório cujo nome corresponde ao idioma da interface do usuário definido para o usuário atual do sistema operacional. Ele foi projetado para permitir que os scripts exibam mensagens do usuário no idioma da interface do usuário selecionado pelo usuário atual.

Import-LocalizedData Importa dados de .psd1 arquivos em subdiretórios específicos do idioma do diretório de script e os salva em uma variável local especificada no comando. O cmdlet seleciona o subdiretório e o arquivo com base no valor da $PSUICulture variável automática. Quando você usa a variável local no script para exibir uma mensagem do usuário, a mensagem aparece no idioma da interface do usuário do usuário.

Você pode usar os parâmetros de para especificar uma cultura, caminho e nome de arquivo alternativos da interface do usuário, para adicionar comandos suportados e para suprimir a mensagem de Import-LocalizedData erro que aparece se os .psd1 arquivos não forem encontrados.

O Import-LocalizedData cmdlet dá suporte à iniciativa de internacionalização de scripts que foi introduzida no Windows PowerShell 2.0. Esta iniciativa visa servir melhor os utilizadores em todo o mundo, tornando mais fácil para os scripts exibirem mensagens do utilizador no idioma da IU do utilizador atual. Para obter mais informações sobre isso e sobre o formato dos .psd1 arquivos, consulte about_Script_Internationalization.

Exemplos

Exemplo 1: Importar cadeias de texto

Este exemplo importa cadeias de caracteres de texto para a $Messages variável. Ele usa os valores padrão de todos os outros parâmetros do cmdlet.

Import-LocalizedData -BindingVariable "Messages"

Se o comando estiver incluído no script Archives.ps1 no C:\Test diretório e o valor da $PsUICulture variável automática for zh-CN, Import-LocalizedData importará o Archives.psd1 arquivo no C:\test\zh-CN diretório para a $Messages variável.

Exemplo 2: Importar cadeias de dados localizadas

Este exemplo é executado na linha de comando, não em um script. Ele obtém cadeias de dados localizadas do arquivo Test.psd1 e as exibe na linha de comando. Como o comando não é usado em um script, o parâmetro FileName é necessário. O comando usa o parâmetro UICulture para especificar a cultura en-US.

Import-LocalizedData -FileName "Test.psd1" -UICulture "en-US"

Name           Value
----           -----
Msg3           "Use $_ to represent the object that's being processed."
Msg2           "This command requires the credentials of a member of the Administrators group on the...
Msg1           "The Name parameter is missing from the command."

Import-LocalizedData Retorna uma hashTable que contém as cadeias de caracteres de dados localizadas.

Exemplo 3: Importar cadeias de caracteres de cultura da interface do usuário

Import-LocalizedData -BindingVariable "MsgTbl" -UICulture "ar-SA" -FileName "Simple" -BaseDirectory "C:\Data\Localized"

Este comando importa cadeias de caracteres de texto para a $MsgTbl variável de um script.

Ele usa o parâmetro UICulture para direcionar o cmdlet para importar dados do Simple.psd1 arquivo no ar-SA subdiretório do C:\Data\Localized.

Exemplo 4: Importar dados localizados para um script

Este exemplo mostra como usar dados localizados em um script simples.

PS C:\> # In C:\Test\en-US\Test.psd1:

ConvertFrom-StringData @'

# English strings

Msg1 = "The Name parameter is missing from the command."
Msg2 = "This command requires the credentials of a member of the Administrators group on the computer."
Msg3 = "Use $_ to represent the object that's being processed."
'@

# In C:\Test\Test.ps1

Import-LocalizedData -BindingVariable "Messages"
Write-Host $Messages.Msg2

# In Windows PowerShell

PS C:\> .\Test.ps1

This command requires the credentials of a member of the Administrators group on the computer.

A primeira parte do exemplo mostra o conteúdo do Test.psd1 arquivo. Ele contém um ConvertFrom-StringData comando que converte uma série de cadeias de caracteres de texto nomeado em uma hashtable. O Test.psd1 arquivo está localizado no subdiretório en-US do C:\Test diretório que contém o script.

A segunda parte do exemplo mostra o conteúdo do Test.ps1 script. Ele contém um Import-LocalizedData comando que importa os dados do arquivo correspondente .psd1 para a $Messages variável e um Write-Host comando que grava uma das mensagens na $Messages variável para o programa host.

A última parte do exemplo executa o script. A saída mostra que ele exibe a mensagem de usuário correta no idioma da interface do usuário definido para o usuário atual do sistema operacional.

Exemplo 5: Substituir cadeias de texto padrão em um script

Este exemplo mostra como usar Import-LocalizedData para substituir cadeias de caracteres de texto padrão definidas na seção DATA de um script.

PS C:\> # In TestScript.ps1
$UserMessages = DATA

{    ConvertFrom-StringData @'

    # English strings

        Msg1 = "Enter a name."
        Msg2 = "Enter your employee ID."
        Msg3 = "Enter your building number."
'@
}

Import-LocalizedData -BindingVariable "UserMessages"
$UserMessages.Msg1...

Neste exemplo, a seção DATA do script TestScript.ps1 contém um ConvertFrom-StringData comando que converte o conteúdo da seção DATA em uma hashtable e armazena $UserMessages o valor da variável.

O script também inclui um Import-LocalizedData comando, que importa uma hashtable de cadeias de texto traduzidas do arquivo TestScript.psd1 no subdiretório especificado pelo valor da $PsUICulture variável. Se o comando encontrar o .psd1 arquivo, ele salvará as cadeias de caracteres traduzidas do arquivo no valor da mesma $UserMessages variável, substituindo a hashtable salva pela lógica da seção DATA.

O terceiro comando exibe a primeira mensagem na $UserMessages variável.

Se o Import-LocalizedData comando encontrar um .psd1 arquivo para o $PsUICulture idioma, o valor da variável conterá as cadeias de $UserMessages texto traduzidas. Se o comando falhar por qualquer motivo, ele exibirá as cadeias de texto padrão definidas na seção DATA do script.

Exemplo 6: Suprimir mensagens de erro se a cultura da interface do usuário não for encontrada

Este exemplo mostra como suprimir as mensagens de erro que aparecem quando Import-LocalizedData não é possível localizar os diretórios que correspondem à cultura da interface do usuário ou não é possível encontrar um .psd1 arquivo para o script nesses diretórios.

PS C:\> # In Day1.ps1

Import-LocalizedData -BindingVariable "Day"

# In Day2.ps1

Import-LocalizedData -BindingVariable "Day" -ErrorAction:SilentlyContinue

PS C:\> .\Day1.ps1
Import-LocalizedData : Can't find PowerShell data file 'Day1.psd1' in directory 'C:\ps-test\fr-BE\'
or any parent culture directories.
At C:\ps-test\Day1.ps1:17 char:21+ Import-LocalizedData <<<<  Day
Today is Tuesday

PS C:\> .\Day2.ps1
Today is Tuesday

Você pode usar o parâmetro comum ErrorAction com um valor de SilentlyContinue para suprimir a mensagem de erro. Isso é especialmente útil quando você forneceu mensagens de usuário em um idioma padrão ou de fallback e nenhuma mensagem de erro é necessária.

Este exemplo compara dois scripts, Day1.ps1 e Day2.ps1, que incluem um Import-LocalizedData comando. Os scripts são idênticos, exceto que Day2 usa o parâmetro comum ErrorAction com um valor de SilentlyContinue.

A saída de exemplo mostra os resultados da execução de ambos os scripts quando a cultura da interface do usuário está definida como fr-BE e não há arquivos ou diretórios correspondentes para essa cultura da interface do usuário. Day1.ps1 exibe uma mensagem de erro e saída em inglês. Day2.ps1 apenas exibe a saída em inglês.

Parâmetros

-BaseDirectory

-BindingVariable

-FileName

-SupportedCommand

-UICulture

Entradas

None

Não é possível canalizar objetos para este cmdlet.

Saídas

Hashtable

Este cmdlet salva a hashtable na variável especificada pelo valor do parâmetro BindingVariable .

Notas

• Antes de usar Import-LocalizedDatao , localize suas mensagens de usuário. Formate as mensagens para cada localidade (cultura da interface do usuário) em uma hashtable de pares chave-valor e salve a hashtable em um arquivo com o mesmo nome do script e uma .psd1 extensão de nome de arquivo. Crie um diretório sob o diretório de script para cada cultura de interface do usuário suportada e, em seguida, salve o .psd1 arquivo para cada cultura de interface do usuário no diretório com o nome da cultura da interface do usuário.

  Por exemplo, localize suas mensagens de usuário para a localidade de-DE e formate-as em uma hashtable. Salve a hashtable em um <ScriptName>.psd1 arquivo. Em seguida, crie um de-DE subdiretório no diretório script e salve o arquivo alemão <ScriptName>.psd1 no de-DE subdiretório. Repita esse método para cada localidade que você suporta.

• Import-LocalizedData Executa uma pesquisa estruturada para as mensagens de usuário localizadas para um script.

  Import-LocalizedData inicia a pesquisa no diretório onde o arquivo de script está localizado (ou o valor do parâmetro BaseDirectory ). Em seguida, ele procura dentro do diretório base por um subdiretório com o mesmo nome que o valor da $PsUICulture variável (ou o valor do parâmetro UICulture ), como de-DE ou ar-SA. Em seguida, ele procura nesse subdiretório um .psd1 arquivo com o mesmo nome do script (ou o valor do parâmetro FileName ).

  Se Import-LocalizedData não conseguir encontrar um subdiretório com o nome da cultura da interface do usuário, ou se o subdiretório não contiver um .psd1 arquivo para o script, ele procurará um .psd1 arquivo para o script em um subdiretório com o nome do código do idioma, como de ou ar. Se não conseguir encontrar o subdiretório ou .psd1 arquivo, o comando falhará, os dados serão exibidos no idioma padrão no script e uma mensagem de erro será exibida explicando que os dados não puderam ser importados. Para suprimir a mensagem e falhar normalmente, use o parâmetro comum ErrorAction com um valor de SilentlyContinue.

  Se Import-LocalizedData encontrar o subdiretório e o .psd1 arquivo, ele importará a hashtable de mensagens do usuário para o valor do parâmetro BindingVariable no comando. Em seguida, quando você exibe uma mensagem da hashtable na variável, a mensagem localizada é exibida.

  Para obter mais informações, consulte about_Script_Internationalization.

Ligações Relacionadas

• Write-Host
• Import-PowerShellDataFile
• about_Data_Files