Udostępnij za pośrednictwem

Import-LocalizedData

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Importuje dane specyficzne dla języka do skryptów i funkcji na podstawie kultury interfejsu użytkownika wybranej dla systemu operacyjnego.

Składnia

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

Opis

Polecenie cmdlet Import-LocalizedData dynamicznie pobiera ciągi z podkatalogu, którego nazwa jest zgodna z językiem interfejsu użytkownika ustawionym dla bieżącego użytkownika systemu operacyjnego. Została zaprojektowana tak, aby umożliwić skryptom wyświetlanie komunikatów użytkownika w języku interfejsu użytkownika wybranym przez bieżącego użytkownika.

Import-LocalizedData importuje dane z plików .psd1 w podkatalogach specyficznych dla języka katalogu skryptu i zapisuje je w zmiennej lokalnej określonej w poleceniu . Polecenie cmdlet wybiera podkatalog i plik na podstawie wartości zmiennej automatycznej $PSUICulture. Gdy używasz zmiennej lokalnej w skrytecie do wyświetlania komunikatu użytkownika, komunikat pojawia się w języku interfejsu użytkownika użytkownika.

Możesz użyć parametrów Import-LocalizedData, aby określić alternatywną kulturę interfejsu użytkownika, ścieżkę i nazwę pliku, aby dodać obsługiwane polecenia i pominąć komunikat o błędzie wyświetlany, jeśli nie znaleziono plików .psd1.

Polecenie cmdlet Import-LocalizedData obsługuje inicjatywę międzynarodowych skryptów, która została wprowadzona w programie Windows PowerShell 2.0. Ta inicjatywa ma na celu lepszą obsługę użytkowników na całym świecie, ułatwiając skryptom wyświetlanie komunikatów użytkowników w języku interfejsu użytkownika bieżącego użytkownika. Aby uzyskać więcej informacji o tym i o formacie plików .psd1, zobacz about_Script_Internationalization.

Przykłady

Przykład 1. Importowanie ciągów tekstowych

W tym przykładzie importuje ciągi tekstowe do zmiennej $Messages. Używa ona wartości domyślnych wszystkich innych parametrów polecenia cmdlet.

Import-LocalizedData -BindingVariable "Messages"

Jeśli polecenie znajduje się w skry skryfcie Archives.ps1 w katalogu C:\Test, a wartość zmiennej automatycznej $PSUICulture jest zh-CN, Import-LocalizedData importuje plik Archives.psd1 w katalogu C:\test\zh-CN do zmiennej $Messages.

Przykład 2. Importowanie zlokalizowanych ciągów danych

Ten przykład jest uruchamiany w wierszu polecenia, a nie w skrycie. Pobiera zlokalizowane ciągi danych z pliku Test.psd1 i wyświetla je w wierszu polecenia. Ponieważ polecenie nie jest używane w skrypsie, wymagany jest parametr FileName. Polecenie używa parametru UICulture, aby określić kulturę 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 zwraca tabelę skrótu zawierającą zlokalizowane ciągi danych.

Przykład 3. Importowanie ciągów kultury interfejsu użytkownika

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

To polecenie importuje ciągi tekstowe do zmiennej $MsgTbl skryptu.

Używa parametru UICulture, aby skierować polecenie cmdlet do zaimportowania danych z pliku Simple.psd1 w podkatalogu ar-SAC:\Data\Localized.

Przykład 4. Importowanie zlokalizowanych danych do skryptu

W tym przykładzie pokazano, jak używać zlokalizowanych danych w prostym skrytecie.

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.

Pierwsza część przykładu przedstawia zawartość pliku Test.psd1. Zawiera ConvertFrom-StringData polecenie, które konwertuje serię nazwanych ciągów tekstowych na tabelę skrótów. Plik Test.psd1 znajduje się w podkatalogu en-US katalogu C:\Test zawierającego skrypt.

Druga część przykładu przedstawia zawartość skryptu Test.ps1. Zawiera on polecenie Import-LocalizedData, które importuje dane z pasującego pliku .psd1 do zmiennej $Messages i polecenie Write-Host, które zapisuje jeden z komunikatów w zmiennej $Messages do programu hosta.

Ostatnia część przykładu uruchamia skrypt. Dane wyjściowe pokazują, że wyświetla prawidłowy komunikat użytkownika w języku interfejsu użytkownika ustawionym dla bieżącego użytkownika systemu operacyjnego.

Przykład 5. Zastępowanie domyślnych ciągów tekstowych w skrypcie

W tym przykładzie pokazano, jak używać Import-LocalizedData do zastępowania domyślnych ciągów tekstowych zdefiniowanych w sekcji DATA skryptu.

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...

W tym przykładzie sekcja DATA skryptu TestScript.ps1 zawiera polecenie ConvertFrom-StringData, które konwertuje zawartość sekcji DATA na tabelę skrótów i przechowuje wartość zmiennej $UserMessages.

Skrypt zawiera również polecenie Import-LocalizedData, które importuje tabelę skrótu przetłumaczonych ciągów tekstowych z pliku TestScript.psd1 w podkatalogu określonym przez wartość zmiennej $PSUICulture. Jeśli polecenie znajdzie plik .psd1, zapisuje przetłumaczone ciągi z pliku w wartości tej samej zmiennej $UserMessages, zastępując tabelę skrótu zapisaną przez logikę sekcji DATA.

Trzecie polecenie wyświetla pierwszy komunikat w zmiennej $UserMessages.

Jeśli polecenie Import-LocalizedData znajdzie plik .psd1 języka $PSUICulture, wartość zmiennej $UserMessages zawiera przetłumaczone ciągi tekstowe. Jeśli polecenie zakończy się niepowodzeniem z jakiegokolwiek powodu, polecenie wyświetli domyślne ciągi tekstowe zdefiniowane w sekcji DATA skryptu.

Przykład 6. Pomijanie komunikatów o błędach, jeśli nie znaleziono kultury interfejsu użytkownika

W tym przykładzie pokazano, jak pominąć komunikaty o błędach wyświetlane, gdy Import-LocalizedData nie mogą znaleźć katalogów pasujących do kultury interfejsu użytkownika użytkownika lub nie można odnaleźć pliku .psd1 dla skryptu w tych katalogach.

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

Aby pominąć komunikat o błędzie, możesz użyć ErrorAction wspólnego parametru z wartością SilentlyContinue. Jest to szczególnie przydatne w przypadku podania komunikatów użytkownika w domyślnym lub rezerwowym języku i nie jest wymagany żaden komunikat o błędzie.

W tym przykładzie porównaliśmy dwa skrypty, Day1.ps1 i Day2.ps1, które zawierają polecenie Import-LocalizedData. Skrypty są identyczne, z wyjątkiem tego, że day2 używa ErrorAction wspólnego parametru z wartością SilentlyContinue.

Przykładowe dane wyjściowe pokazują wyniki uruchamiania obu skryptów, gdy kultura interfejsu użytkownika jest ustawiona na fr-BE i nie ma pasujących plików ani katalogów dla tej kultury interfejsu użytkownika. Day1.ps1 wyświetla komunikat o błędzie i dane wyjściowe w języku angielskim. Day2.ps1 wyświetla tylko angielskie dane wyjściowe.

Parametry

-BaseDirectory

Określa katalog podstawowy, w którym znajdują się pliki .psd1. Wartość domyślna to katalog, w którym znajduje się skrypt. Import-LocalizedData wyszukuje plik .psd1 dla skryptu w podkatalogu specyficznym dla języka katalogu podstawowego.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-BindingVariable

Określa zmienną, do której są importowane ciągi tekstowe. Wprowadź nazwę zmiennej bez znaku dolara ($).

W programie Windows PowerShell 2.0 ten parametr jest wymagany. W programie Windows PowerShell 3.0 ten parametr jest opcjonalny. Jeśli pominiesz ten parametr, Import-LocalizedData zwraca tabelę skrótów ciągów tekstowych. Tabela skrótów jest przekazywana w potoku lub wyświetlana w wierszu polecenia.

W przypadku używania Import-LocalizedData do zastępowania domyślnych ciągów tekstowych określonych w sekcji DATA skryptu przypisz sekcję DATA do zmiennej i wprowadź nazwę zmiennej sekcji DATA w wartości parametru BindingVariable. Następnie, gdy Import-LocalizedData zapisze zaimportowaną zawartość w BindingVariable, zaimportowane dane zastąpią domyślne ciągi tekstowe. Jeśli nie określasz domyślnych ciągów tekstowych, możesz wybrać dowolną nazwę zmiennej.

Typ:String
Aliasy:Variable
Position:0
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-FileName

Określa nazwę pliku danych (.psd1) do zaimportowania. Wprowadź nazwę pliku. Można określić nazwę pliku, która nie zawiera jego .psd1 rozszerzenia nazwy pliku lub można określić nazwę pliku, w tym rozszerzenie nazwy pliku .psd1. Pliki danych powinny być zapisywane jako Unicode lub UTF-8.

Parametr FileName jest wymagany, gdy Import-LocalizedData nie jest używany w skrypsie. W przeciwnym razie parametr jest opcjonalny, a wartość domyślna to nazwa podstawowa skryptu. Tego parametru można użyć do kierowania Import-LocalizedData do wyszukiwania innego pliku .psd1.

Jeśli na przykład FileName zostanie pominięta, a nazwa skryptu to FindFiles.ps1, Import-LocalizedData wyszukuje plik danych FindFiles.psd1.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-SupportedCommand

Określa polecenia cmdlet i funkcje, które generują tylko dane.

Użyj tego parametru, aby uwzględnić polecenia cmdlet i funkcje, które zostały napisane lub przetestowane. Aby uzyskać więcej informacji, zobacz about_Script_Internationalization.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-UICulture

Określa alternatywną kulturę interfejsu użytkownika. Wartość domyślna to wartość zmiennej automatycznej $PSUICulture. Wprowadź kulturę interfejsu użytkownika w formacie <language>-<region>, takim jak en-US, de-DElub ar-SA.

Wartość parametru UICulture określa podkatalog specyficzny dla języka (w katalogu podstawowym), z którego Import-LocalizedData pobiera plik .psd1 skryptu.

Polecenie cmdlet wyszukuje podkatalog o takiej samej nazwie jak wartość parametru UICulture lub zmiennej automatycznej $PSUICulture, takiej jak de-DE lub ar-SA. Jeśli nie można odnaleźć katalogu lub katalog nie zawiera pliku .psd1 skryptu, wyszukuje podkatalog o nazwie kodu języka, takiego jak de lub ar. Jeśli nie można odnaleźć podkatalogu lub pliku .psd1, polecenie zakończy się niepowodzeniem, a dane zostaną wyświetlone w domyślnym języku określonym w skry skrycie.

Typ:String
Position:1
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

None

Nie można potokować obiektów do tego polecenia cmdlet.

Dane wyjściowe

Hashtable

To polecenie cmdlet zapisuje tabelę skrótów w zmiennej określonej przez wartość parametru BindingVariable.

Uwagi

  • Przed użyciem Import-LocalizedDatazlokalizuj komunikaty użytkowników. Sformatuj komunikaty dla każdej kultury ustawień regionalnych (kultury interfejsu użytkownika) w tabeli skrótowej par klucz-wartość i zapisz tabelę skrótu w pliku o tej samej nazwie co skrypt i rozszerzenie nazwy pliku .psd1. Utwórz katalog w katalogu script dla każdej obsługiwanej kultury interfejsu użytkownika, a następnie zapisz plik .psd1 dla każdej kultury interfejsu użytkownika w katalogu z nazwą kultury interfejsu użytkownika.

    Na przykład lokalizowanie komunikatów użytkownika dla ustawień regionalnych de-DE i formatowanie ich w tabeli skrótów. Zapisz tabelę skrótu w pliku <ScriptName>.psd1. Następnie utwórz podkatalog de-DE w katalogu script i zapisz niemiecki plik <ScriptName>.psd1 w podkatalogu de-DE. Powtórz tę metodę dla wszystkich ustawień regionalnych, które są obsługiwane.

  • Import-LocalizedData wykonuje ustrukturyzowane wyszukiwanie zlokalizowanych komunikatów użytkownika dla skryptu.

    Import-LocalizedData rozpoczyna wyszukiwanie w katalogu, w którym znajduje się plik skryptu (lub wartość parametru BaseDirectory). Następnie wyszukuje w katalogu podstawowym podkatalog o tej samej nazwie co wartość zmiennej $PSUICulture (lub wartość parametru UICulture), na przykład de-DE lub ar-SA. Następnie wyszukuje w tym podkatalogu plik .psd1 o takiej samej nazwie jak skrypt (lub wartość parametru FileName).

    Jeśli Import-LocalizedData nie może znaleźć podkatalogu o nazwie kultury interfejsu użytkownika lub podkatalog nie zawiera pliku .psd1 dla skryptu, wyszukuje plik .psd1 skryptu w podkatalogu o nazwie kodu języka, takiego jak de lub ar. Jeśli nie można odnaleźć podkatalogu lub pliku .psd1, polecenie zakończy się niepowodzeniem, dane są wyświetlane w języku domyślnym w skry skrycie i zostanie wyświetlony komunikat o błędzie wyjaśniający, że nie można zaimportować danych. Aby pominąć komunikat i pomyślnie zakończyć się niepowodzeniem, użyj ErrorAction wspólnego parametru z wartością SilentlyContinue.

    Jeśli Import-LocalizedData znajdzie podkatalog i plik .psd1, importuje tabelę skrótów komunikatów użytkownika do wartości parametru BindingVariable w poleceniu. Następnie po wyświetleniu komunikatu z tabeli skrótu w zmiennej zostanie wyświetlony zlokalizowany komunikat.

    Aby uzyskać więcej informacji, zobacz about_Script_Internationalization.