Get-Help

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

Wyświetla informacje o poleceniach i pojęciach programu PowerShell.

Składnia

Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Full]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Detailed
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Examples
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   -Parameter <String[]>
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -Online
   [<CommonParameters>]
Get-Help
   [[-Name] <String>]
   [-Path <String>]
   [-Category <String[]>]
   [-Component <String[]>]
   [-Functionality <String[]>]
   [-Role <String[]>]
   -ShowWindow
   [<CommonParameters>]

Opis

Polecenie Get-Help cmdlet wyświetla informacje dotyczące pojęć i poleceń programu PowerShell, w tym poleceń cmdlet, funkcji, poleceń modelu wspólnych informacji (CIM), przepływów pracy, dostawców, aliasów i skryptów.

Aby uzyskać pomoc dotyczącą polecenia cmdlet programu PowerShell, wpisz Get-Help nazwę polecenia cmdlet, na przykład: Get-Help Get-Process.

Artykuły pomocy koncepcyjnej w programie PowerShell zaczynają się od about_, takich jak about_Comparison_Operators. Aby wyświetlić wszystkie artykuły about_, wpisz Get-Help about_*. Aby wyświetlić konkretny artykuł, wpisz Get-Help about_<article-name>, na przykład Get-Help about_Comparison_Operators.

Aby uzyskać pomoc dotyczącą dostawcy programu PowerShell, wpisz Get-Help nazwę dostawcy. Aby na przykład uzyskać pomoc dotyczącą dostawcy certyfikatów, wpisz Get-Help Certificate.

Możesz również wpisać help lub man, który wyświetla jeden ekran tekstu naraz. Lub , <cmdlet-name> -?jest to identyczne z Get-Help, ale działa tylko w przypadku poleceń cmdlet.

Get-Help Pobiera zawartość pomocy wyświetlaną z plików pomocy na komputerze. Bez plików Get-Help pomocy wyświetla tylko podstawowe informacje o poleceniach cmdlet. Niektóre moduły programu PowerShell zawierają pliki pomocy. Począwszy od programu PowerShell 3.0, moduły dostarczane z systemem operacyjnym Windows nie zawierają plików pomocy. Aby pobrać lub zaktualizować pliki pomocy dla modułu w programie PowerShell 3.0, użyj Update-Help polecenia cmdlet .

Możesz również wyświetlić dokumenty pomocy programu PowerShell w trybie online. Aby uzyskać wersję online pliku pomocy, użyj parametru Online , takiego jak : Get-Help Get-Process -Online.

Jeśli wpiszesz Get-Help dokładną nazwę artykułu pomocy lub słowo unikatowe dla artykułu pomocy, Get-Help wyświetla zawartość artykułu. Jeśli określisz dokładną nazwę aliasu polecenia, Get-Help wyświetli pomoc dla oryginalnego polecenia. Jeśli wprowadzisz wzorzec wyrazu lub wyrazu, który pojawia się w kilku tytułach artykułu pomocy, Get-Help zostanie wyświetlona lista pasujących tytułów. Jeśli wprowadzisz dowolny tekst, który nie jest wyświetlany w żadnym tytule artykułu pomocy, Get-Help zostanie wyświetlona lista artykułów zawierających ten tekst w ich zawartości.

Get-Help może uzyskać artykuły pomocy dotyczące wszystkich obsługiwanych języków i ustawień regionalnych. Get-HelpNajpierw szuka plików pomocy w ustawieniach regionalnych systemu Windows, a następnie w ustawieniach regionalnych nadrzędnych, takich jak pt dla pt-BR, a następnie w rezerwowych ustawieniach regionalnych. Począwszy od programu PowerShell 3.0, jeśli Get-Help nie znajdzie pomocy w ustawieniach regionalnych rezerwowych, szuka artykułów pomocy w języku angielskim, en-US, zanim zwróci komunikat o błędzie lub wyświetli automatycznie wygenerowaną pomoc.

Aby uzyskać informacje o symbolach wyświetlanych Get-Help na diagramie składni poleceń, zobacz about_Command_Syntax. Aby uzyskać informacje o atrybutach parametrów, takich jak Wymagane i Położenie, zobacz about_Parameters.

Uwaga

W programach PowerShell 3.0 i PowerShell 4.0 nie można znaleźć artykułów About (Informacje) w modułach, Get-Help chyba że moduł zostanie zaimportowany do bieżącej sesji. Aby uzyskać informacje o artykułach w module, zaimportuj moduł przy użyciu Import-Module polecenia cmdlet lub uruchamiając polecenie cmdlet uwzględnione w module.

Począwszy od programu PSReadLine w wersji 2.2.2, moduł jest dostarczany z dwiema funkcjami, które zapewniają szybki dostęp do pomocy podczas wpisywania polecenia w wierszu polecenia. Pomoc jest wyświetlana w terminalu w alternatywnym buforze ekranu z stronicowaniem.

Po naciśnięciu klawisza F1 funkcja PSReadLineShowCommandHelp wywołuje Get-Help -Full nazwę polecenia cmdlet znajdującą się najbliżej lewej strony kursora. Gdy kursor znajduje się natychmiast po lewej stronie parametru, funkcja przechodzi do opisu tego parametru w pełnym temacie pomocy. Po naciśnięciu klawisza Q , aby zamknąć widok pomocy, zostaniesz zwrócony do wiersza polecenia w tym samym położeniu kursora, aby kontynuować wpisywanie polecenia.

Gdy używasz kombinacji klawiszy Alt+h, funkcja PSReadLineShowParameterHelp wyświetla informacje pomocy dla parametru natychmiast po lewej stronie kursora. Tekst pomocy jest wyświetlany poniżej wiersza polecenia. Dzięki temu możesz zobaczyć opis parametru i kontynuować wpisywanie polecenia.

Aby uzyskać więcej informacji, zobacz Korzystanie z pomocy dynamicznej.

Przykłady

Przykład 1. Wyświetlanie podstawowych informacji pomocy dotyczących polecenia cmdlet

Te przykłady zawierają podstawowe informacje pomocy dotyczące Format-Table polecenia cmdlet.

Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?

Get-Help <cmdlet-name> jest najprostszą i domyślną składnią Get-Help polecenia cmdlet. Można pominąć parametr Name .

Składnia <cmdlet-name> -? działa tylko w przypadku poleceń cmdlet.

Przykład 2. Wyświetlanie podstawowych informacji o jednej stronie naraz

W tych przykładach są wyświetlane podstawowe informacje pomocy dotyczące Format-Table polecenia cmdlet pojedynczo.

help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging

help jest funkcją uruchamiającą Get-Help polecenie cmdlet wewnętrznie i wyświetlającą wynik po jednej stronie naraz.

man jest aliasem help dla funkcji.

Get-Help Format-Table wysyła obiekt w dół potoku. Out-Host -Paging odbiera dane wyjściowe z potoku i wyświetla jedną stronę naraz. Aby uzyskać więcej informacji, zobacz Out-Host (Host wychodzący).

Przykład 3. Wyświetlanie dodatkowych informacji dla polecenia cmdlet

Te przykłady zawierają bardziej szczegółowe informacje pomocy dotyczące Format-Table polecenia cmdlet.

Get-Help Format-Table -Detailed
Get-Help Format-Table -Full

Szczegółowy parametr zawiera szczegółowy widok artykułu pomocy, który zawiera opisy parametrów i przykłady.

Pełny parametr wyświetla pełny widok artykułu pomocy, który zawiera opisy parametrów, przykłady, typy obiektów wejściowych i wyjściowych oraz dodatkowe uwagi.

Parametry Szczegółowe i Pełne są skuteczne tylko dla poleceń, które mają pliki pomocy zainstalowane na komputerze. Parametry nie są skuteczne w artykułach pomocy dotyczących pojęć (about_).

Przykład 4. Wyświetlanie wybranych części polecenia cmdlet przy użyciu parametrów

W tych przykładach Format-Table są wyświetlane wybrane fragmenty pomocy polecenia cmdlet.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Parametr Examples zawiera sekcje NAME i SYNOPSIS pliku pomocy oraz wszystkie przykłady. Nie można określić przykładowej liczby, ponieważ parametr Examples jest parametrem switch.

Parametr parametru wyświetla tylko opisy określonych parametrów. Jeśli określisz tylko symbol wieloznaczny gwiazdki (*), zostanie wyświetlony opis wszystkich parametrów. Gdy parametr określa nazwę parametru, taką jak GroupBy, wyświetlane są informacje o tym parametrze.

Te parametry nie są skuteczne w artykułach pomocy dotyczących pojęć (about_).

Przykład 5. Wyświetlanie wersji pomocy online

W tym przykładzie zostanie wyświetlona wersja online artykułu pomocy dla Format-Table polecenia cmdlet w domyślnej przeglądarce internetowej.

Get-Help Format-Table -Online

Przykład 6. Wyświetlanie pomocy dotyczącej systemu pomocy

Polecenie Get-Help cmdlet bez parametrów wyświetla informacje o systemie pomocy programu PowerShell.

Get-Help

Przykład 7. Wyświetlanie dostępnych artykułów pomocy

W tym przykładzie zostanie wyświetlona lista wszystkich artykułów pomocy dostępnych na komputerze.

Get-Help *

Przykład 8. Wyświetlanie listy artykułów koncepcyjnych

W tym przykładzie przedstawiono listę artykułów koncepcyjnych zawartych w pomocy programu PowerShell. Wszystkie te artykuły zaczynają się od znaków about_. Aby wyświetlić określony plik pomocy, wpisz Get-Help \<about_article-name\>na przykład Get-Help about_Signing.

Wyświetlane są tylko artykuły koncepcyjne, które zawierają pliki pomocy zainstalowane na komputerze. Aby uzyskać informacje na temat pobierania i instalowania plików pomocy w programie PowerShell 3.0, zobacz Update-Help (Pomoc dotycząca aktualizacji).

Get-Help about_*

Przykład 9. Wyszukiwanie wyrazu w pomocy polecenia cmdlet

W tym przykładzie pokazano, jak wyszukać słowo w artykule pomocy dotyczącej poleceń cmdlet.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help używa parametru Full , aby uzyskać informacje pomocy dla elementu Add-Member. Obiekt MamlCommandHelpInfo jest wysyłany w dół potoku. Out-String używa parametru stream , aby przekonwertować obiekt na ciąg. Select-Stringużywa parametru Pattern, aby wyszukać ciąg clixml.

Przykład 10: wyświetlanie listy artykułów zawierających wyraz

W tym przykładzie zostanie wyświetlona lista artykułów zawierających słowo remoting.

Po wprowadzeniu wyrazu, który nie jest wyświetlany w żadnym tytule artykułu, Get-Help zostanie wyświetlona lista artykułów zawierających ten wyraz.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Przykład 11: Wyświetlanie pomocy specyficznej dla dostawcy

W tym przykładzie przedstawiono dwa sposoby uzyskiwania pomocy specyficznej dla dostawcy dla usługi Get-Item. Te polecenia ułatwiają wyjaśnienie, jak używać Get-Item polecenia cmdlet w węźle DataCollection dostawcy programu Sql Server programu PowerShell.

W pierwszym przykładzie użyto parametru Get-HelpPath do określenia ścieżki dostawcy programu SQL Server. Ponieważ ścieżka dostawcy jest określona, można uruchomić polecenie z dowolnej lokalizacji ścieżki.

W drugim przykładzie użyto Set-Location polecenia , aby przejść do ścieżki dostawcy programu SQL Server. Z tej lokalizacji parametr Path nie jest wymagany do Get-Help uzyskania pomocy specyficznej dla dostawcy.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Przykład 12. Wyświetlanie pomocy dotyczącej skryptu

W tym przykładzie uzyskasz pomoc dotyczącą elementu MyScript.ps1 script. Aby uzyskać informacje o sposobie pisania pomocy dotyczącej funkcji i skryptów, zobacz about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parametry

-Category

Wyświetla pomoc tylko dla elementów w określonej kategorii i ich aliasach. Artykuły koncepcyjne znajdują się w kategorii HelpFile .

Dopuszczalne wartości tego parametru są następujące:

  • Alias
  • Polecenia cmdlet
  • Dostawca
  • Ogólne
  • Często zadawane pytania
  • Słownik
  • Helpfile
  • ScriptCommand
  • Function
  • Filtr
  • ExternalScript
  • wszystkie
  • DefaultHelp
  • Przepływ pracy
  • DscResource
  • Klasa
  • Konfigurowanie
Type:String[]
Accepted values:Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Component

Wyświetla polecenia z określoną wartością składnika, taką jak Exchange. Wprowadź nazwę składnika. Dozwolone są symbole wieloznaczne. Ten parametr nie ma wpływu na wyświetlanie pomocy koncepcyjnej (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Detailed

Dodaje opisy parametrów i przykłady do wyświetlania podstawowej pomocy. Ten parametr jest skuteczny tylko wtedy, gdy pliki pomocy są zainstalowane na komputerze. Nie ma to wpływu na wyświetlanie pomocy koncepcyjnej (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Examples

Wyświetla tylko nazwę, streszczenie i przykłady. Ten parametr jest skuteczny tylko wtedy, gdy pliki pomocy są zainstalowane na komputerze. Nie ma to wpływu na wyświetlanie pomocy koncepcyjnej (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Full

Wyświetla cały artykuł pomocy dla polecenia cmdlet. Pełna zawiera opisy parametrów i atrybuty, przykłady, typy obiektów wejściowych i wyjściowych oraz dodatkowe uwagi.

Ten parametr jest skuteczny tylko wtedy, gdy pliki pomocy są zainstalowane na komputerze. Nie ma to wpływu na wyświetlanie pomocy koncepcyjnej (About_).

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Functionality

Wyświetla pomoc dotyczącą elementów z określoną funkcjonalnością. Wprowadź funkcjonalność. Dozwolone są symbole wieloznaczne. Ten parametr nie ma wpływu na wyświetlanie pomocy koncepcyjnej (About_).

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

Pobiera pomoc dotyczącą określonego polecenia lub koncepcji. Wprowadź nazwę polecenia cmdlet, funkcji, dostawcy, skryptu lub przepływu pracy, na Get-Memberprzykład , nazwę artykułu koncepcyjnego, taką jak about_Objects, lub alias, taki jak ls. Symbole wieloznaczne są dozwolone w nazwach poleceń cmdlet i dostawców, ale nie można używać symboli wieloznacznych do znajdowania nazw pomocy funkcji i artykułów pomocy skryptu.

Aby uzyskać pomoc dotyczącą skryptu, który nie znajduje się w ścieżce wymienionej w zmiennej $env:Path środowiskowej, wpisz ścieżkę skryptu i nazwę pliku.

Jeśli wprowadzisz dokładną nazwę artykułu pomocy, Get-Help zostanie wyświetlona zawartość artykułu.

Jeśli wprowadzisz wzorzec wyrazu lub wyrazu, który pojawia się w kilku tytułach artykułu pomocy, Get-Help zostanie wyświetlona lista pasujących tytułów.

Jeśli wprowadzisz dowolny tekst, który nie jest zgodny z żadnymi tytułami artykułów pomocy, Get-Help zostanie wyświetlona lista artykułów zawierających ten tekst w ich zawartości.

Nazwy artykułów koncepcyjnych, takich jak about_Objects, muszą być wprowadzone w języku angielskim, nawet w wersjach innych niż angielski programu PowerShell.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Online

Wyświetla wersję online artykułu pomocy w domyślnej przeglądarce. Ten parametr jest prawidłowy tylko w artykułach pomocy dotyczących poleceń cmdlet, funkcji, przepływu pracy i skryptu. Nie można użyć parametru Get-Help Online w sesji zdalnej.

Aby uzyskać informacje na temat obsługi tej funkcji w artykułach pomocy, które piszesz, zobacz about_Comment_Based_Help i Obsługa pomocy online oraz Pisanie pomocy dotyczącej poleceń cmdlet programu PowerShell.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Parameter

Wyświetla tylko szczegółowe opisy określonych parametrów. Dozwolone są symbole wieloznaczne. Ten parametr nie ma wpływu na wyświetlanie pomocy koncepcyjnej (About_).

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-Path

Otrzymuje pomoc, która wyjaśnia, jak polecenie cmdlet działa w określonej ścieżce dostawcy. Wprowadź ścieżkę dostawcy programu PowerShell.

Ten parametr pobiera dostosowaną wersję artykułu pomocy dotyczącej polecenia cmdlet, który wyjaśnia, jak polecenie cmdlet działa w określonej ścieżce dostawcy programu PowerShell. Ten parametr jest skuteczny tylko w przypadku pomocy dotyczącej polecenia cmdlet dostawcy i tylko wtedy, gdy dostawca zawiera niestandardową wersję artykułu pomocy dotyczącej polecenia cmdlet dostawcy w pliku pomocy. Aby użyć tego parametru, zainstaluj plik pomocy dla modułu zawierającego dostawcę.

Aby wyświetlić niestandardową pomoc dla ścieżki dostawcy, przejdź do lokalizacji ścieżki dostawcy i wprowadź Get-Help polecenie lub, z dowolnej lokalizacji ścieżki, użyj parametru Path , Get-Help aby określić ścieżkę dostawcy. Niestandardową pomoc dotyczącą poleceń cmdlet można również znaleźć w trybie online w sekcji pomocy dostawcy artykułów pomocy.

Aby uzyskać więcej informacji na temat dostawców programu PowerShell, zobacz about_Providers.

Uwaga

Dostawca określonej ścieżki musi mieć zainstalowany plik pomocy dostawcy programu PowerShell. Jeśli plik pomocy dostawcy nie jest dostępny, nie są zwracane żadne informacje pomocy. Brak plików pomocy dostawcy dostępnych dla dostawców dołączonych do tej wersji programu PowerShell.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Role

Wyświetla pomoc dostosowaną dla określonej roli użytkownika. Wprowadź rolę. Dozwolone są symbole wieloznaczne.

Wprowadź rolę, jaką użytkownik odgrywa w organizacji. Niektóre polecenia cmdlet wyświetlają inny tekst w swoich plikach pomocy na podstawie wartości tego parametru. Ten parametr nie ma wpływu na pomoc dla podstawowych poleceń cmdlet.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowWindow

Wyświetla temat pomocy w oknie, aby ułatwić czytanie. Okno zawiera funkcję wyszukiwania Znajdź i pole Ustawienia, które pozwala ustawić opcje wyświetlania, w tym opcje wyświetlania tylko wybranych sekcji tematu pomocy.

Parametr ShowWindow obsługuje tematy pomocy dotyczące poleceń (poleceń cmdlet, funkcji, poleceń CIM, skryptów) i artykułów dotyczących pojęć. Nie obsługuje pomocy dostawcy.

Ten parametr został przywrócony w programie PowerShell 7.0. Ten parametr jest dostępny tylko w systemie Windows.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Dane wejściowe

None

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

Dane wyjściowe

ExtendedCmdletHelpInfo

Jeśli uruchomisz polecenie Get-Help , które nie ma pliku pomocy, Get-Help zwraca obiekt ExtendedCmdletHelpInfo reprezentujący automatycznie wygenerowaną pomoc.

String

Jeśli uzyskasz artykuł pomocy koncepcyjnej, Get-Help zwraca go jako ciąg.

MamlCommandHelpInfo

Jeśli otrzymasz polecenie z plikiem pomocy, Get-Help zwraca obiekt MamlCommandHelpInfo .

Uwagi

Program PowerShell 3.0 nie zawiera plików pomocy. Aby pobrać i zainstalować pliki pomocy, które Get-Help odczytuje, użyj Update-Help polecenia cmdlet . Możesz użyć Update-Help polecenia cmdlet , aby pobrać i zainstalować pliki pomocy dla podstawowych poleceń dołączonych do programu PowerShell i dla wszystkich zainstalowanych modułów. Można go również użyć do zaktualizowania plików pomocy, aby pomoc na komputerze nigdy nie była nieaktualna.

Możesz również przeczytać artykuły pomocy dotyczące poleceń dostępnych w trybie online programu PowerShell, począwszy od artykułu Wprowadzenie do programu Windows PowerShell.

Get-Help Wyświetla pomoc w ustawieniach regionalnych ustawionych dla systemu operacyjnego Windows lub w języku rezerwowym dla tych ustawień regionalnych. Jeśli nie masz plików pomocy dla ustawień regionalnych podstawowych lub rezerwowych, zachowuje się tak, Get-Help jakby na komputerze nie ma żadnych plików pomocy. Aby uzyskać pomoc dotyczącą różnych ustawień regionalnych, użyj pozycji Region i Język w Panel sterowania, aby zmienić ustawienia. W systemie Windows 10 lub nowszym Ustawienia, Czas i język.

Pełny widok pomocy zawiera tabelę informacji o parametrach. Tabela zawiera następujące pola:

  • Wymagany. Wskazuje, czy parametr jest wymagany (true) czy opcjonalny (false).

  • Położenie. Wskazuje, czy parametr ma nazwę, czy pozycyjną (liczbową). Parametry pozycyjne muszą być wyświetlane w określonym miejscu w poleceniu.

  • Nazwana wskazuje, że nazwa parametru jest wymagana, ale parametr może pojawić się w dowolnym miejscu w poleceniu.

  • Wartość liczbowa wskazuje, że nazwa parametru jest opcjonalna, ale gdy nazwa zostanie pominięta, parametr musi znajdować się w miejscu określonym przez liczbę. Na przykład wskazuje, 2 że gdy nazwa parametru zostanie pominięta, parametr musi być drugim lub tylko nienazwanym parametrem w poleceniu. Gdy nazwa parametru jest używana, parametr może pojawić się w dowolnym miejscu w poleceniu.

  • Wartość domyślna. Wartość parametru lub domyślne zachowanie używane przez program PowerShell, jeśli nie dołączysz parametru do polecenia.

  • Akceptuje dane wejściowe potoku. Wskazuje, czy można (prawda) lub nie (fałsz) wysyłać obiektów do parametru za pośrednictwem potoku. Według nazwy właściwości oznacza, że obiekt potoku musi mieć właściwość, która ma taką samą nazwę jak nazwa parametru.

  • Akceptuje symbole wieloznaczne. Wskazuje, czy wartość parametru może zawierać symbole wieloznaczne, takie jak gwiazdka (*) lub znak zapytania (?).