Get-Help
Wyświetla informacje o poleceniach i pojęciach programu PowerShell.
Składnia
AllUsersView (domyślnie)
Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[-Full]
[<CommonParameters>]
DetailedView
Get-Help
[[-Name] <String>]
-Detailed
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Examples
Get-Help
[[-Name] <String>]
-Examples
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Parameters
Get-Help
[[-Name] <String>]
-Parameter <String>
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Online
Get-Help
[[-Name] <String>]
-Online
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
ShowWindow
Get-Help
[[-Name] <String>]
-ShowWindow
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Opis
Polecenie cmdlet Get-Help wyświetla informacje o pojęciach i poleceniach programu PowerShell, w tym poleceniach cmdlet, funkcjach, poleceniach modelu wspólnych informacji (CIM), przepływach pracy, dostawcach, aliasach i skryptach.
Aby uzyskać pomoc dotyczącą polecenia cmdlet programu PowerShell, wpisz Get-Help, a następnie nazwę polecenia cmdlet, taką jak: Get-Help Get-Process.
Artykuły pomocy koncepcyjnej w programie PowerShell zaczynają się od about_, na przykład about_Comparison_Operators. Aby wyświetlić wszystkie artykuły o, 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, a następnie 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> -?, który jest identyczny z Get-Help, ale działa tylko w przypadku poleceń cmdlet.
Get-Help pobiera treść pomocy z plików pomocy na komputerze i wyświetla ją. Bez plików pomocy, Get-Help wyświetla tylko podstawowe informacje o cmdletach. 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 polecenia cmdlet Update-Help.
Dokumenty pomocy programu PowerShell można również wyświetlić w trybie online w witrynie Microsoft Docs. Aby uzyskać wersję online pliku pomocy, użyj parametru usługi
Jeśli wpiszesz Get-Help, a następnie dokładną nazwę artykułu pomocy lub słowo unikatowe dla artykułu pomocy, Get-Help wyświetla zawartość artykułu. Jeśli wprowadzisz wzorzec słowa lub wyrazu, który pojawi się w kilku tytułach artykułu pomocy, Get-Help wyświetli listę pasujących tytułów. Jeśli wprowadzisz wyraz, który nie będzie wyświetlany w żadnym tytule artykułu pomocy, Get-Help wyświetli listę artykułów, które zawierają ten wyraz w ich zawartości.
Artykuły pomocy dla wszystkich obsługiwanych języków i ustawień regionalnych można znaleźć za pomocą Get-Help.
Get-Help najpierw szuka plików pomocy w ustawieniach regionalnych dla 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 rezerwowej lokalizacji, szuka artykułów pomocy w języku angielskim, en-US, zanim wyświetli komunikat o błędzie lub automatycznie wygenerowaną pomoc.
Aby uzyskać informacje o symbolach, które Get-Help wyświetla na diagramie składni poleceń, zobacz about_Command_Syntax.
Aby uzyskać informacje o atrybutach parametrów, takich jak Wymagane i Pozycja, zobacz about_Parameters.
Uwaga / Notatka
W programach PowerShell 3.0 i PowerShell 4.0 Get-Help nie można znaleźć artykuły about w modułach, chyba że moduł zostanie zaimportowany do bieżącej sesji. Jest to znany problem. Aby uzyskać artykuły about w module, zaimportuj moduł przy użyciu polecenia cmdlet Import-Module lub uruchamiając polecenie cmdlet dołączone do modułu.
Przykłady
Przykład 1. Wyświetlanie podstawowych informacji pomocy dotyczących polecenia cmdlet
Przykłady te zawierają podstawowe informacje pomocy dotyczące cmdletu Format-Table.
Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?
Get-Help <cmdlet-name> jest najprostszą i domyślną składnią polecenia cmdlet Get-Help. Możesz pominąć parametr Nazwa.
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 wyświetlane są podstawowe informacje dotyczące pomocy dla polecenia cmdlet Format-Table strona po stronie.
help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging
help jest funkcją, która uruchamia wewnętrznie polecenie cmdlet Get-Help i wyświetla wynik strona po stronie.
man jest aliasem funkcji help.
Get-Help Format-Table wysyła obiekt w dół potoku.
Out-Host -Paging odbiera dane wyjściowe z potoku i wyświetla je jedną stronę na raz. Aby uzyskać więcej informacji, zobacz Out-Host.
Przykład 3. Wyświetlanie dodatkowych informacji dla polecenia cmdlet
Te przykłady pokazują bardziej szczegółowe informacje dotyczące polecenia cmdlet Format-Table.
Get-Help Format-Table -Detailed
Get-Help Format-Table -Full
Parametr szczegółowy wyświetla widok szczegółowy artykułu pomocy, który zawiera opisy parametrów i przykłady.
Parametr Full 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 w przypadku poleceń, które mają zainstalowane pliki pomocy na komputerze. Parametry nie są skuteczne w koncepcyjnych artykułach pomocy (about_).
Przykład 4. Wyświetlanie wybranych części polecenia cmdlet przy użyciu parametrów
W tych przykładach są wyświetlane wybrane fragmenty pomocy polecenia cmdlet Format-Table.
Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy
Parametr Examples wyświetla sekcje NAME i SYNOPSIS pliku pomocy oraz wszystkie przykłady. Nie można określić przykładowej liczby, ponieważ parametr Przykłady jest parametrem przełącznika.
Parametr wyświetla tylko opisy określonych parametrów. Jeśli określisz tylko symbol wieloznaczny gwiazdka (*), to wyświetli opisy wszystkich parametrów.
Gdy Parametr określa nazwę parametru, taką jak GroupBy, są wyświetlane informacje o tym parametrze.
Te parametry nie są skuteczne dla artykułów pomocy dotyczących pojęć (about_).
Przykład 5. Wyświetlanie wersji pomocy online
W tym przykładzie wyświetlana jest wersja online artykułu pomocy dla cmdletu Format-Table w domyślnej przeglądarce internetowej.
Get-Help Format-Table -Online
Przykład 6. Wyświetlanie pomocy dotyczącej systemu pomocy
Polecenie cmdlet Get-Help 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.
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 dotyczące pomocy dla Add-Member. Obiekt MamlCommandHelpInfo jest przekazywany dalej wzdłuż potoku.
Out-String używa parametru Stream, aby przekonwertować obiekt na ciąg.
Select-String używa parametru wzorca do wyszukiwania ciągu Clixml .
Przykład 10: wyświetlanie listy artykułów zawierających wyraz
W tym przykładzie jest wyświetlana lista artykułów zawierających wyraz zdalne połączenie.
Po wprowadzeniu wyrazu, który nie jest wyświetlany w żadnym tytule artykułu, Get-Help wyświetla listę 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 dostosowanej do dostawcy dla Get-Item. Te polecenia uzyskują pomoc wyjaśniającą, jak używać cmdletu Get-Item w węźle DataCollection dostawcy programu SQL Server w PowerShell.
W pierwszym przykładzie użyto parametru Get-HelpPath w celu 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, aby przejść do ścieżki dostawcy programu SQL Server. Parametr ścieżki z tej lokalizacji nie jest wymagany, aby Get-Help uzyskał pomoc specyficzną 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 uzyskuje się pomoc dla 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:
- Pseudonim
- Cmdlet
- Dostawca
- Ogólne
- Często zadawane pytania
- Słownik
- HelpFile
- ScriptCommand
- Funkcja
- Filtr
- ZewnętrznySkrypt
- Wszystko
- DefaultHelp
- Workflow
- DscResource
- Klasa
- Konfiguracja
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Dopuszczalne wartości: | Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Component
Wyświetla polecenia z określoną wartością składnika, takie jak Exchange. Wprowadź nazwę składnika. Symbole wieloznaczne są dozwolone. Ten parametr nie ma wpływu na wyświetlanie pomocy koncepcyjnej (About_).
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-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_).
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
DetailedView
| Position: | Named |
| Obowiązkowe: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Examples
Wyświetla tylko nazwę, streszczenie i przykłady. Aby wyświetlić tylko przykłady, wpisz (Get-Help \<cmdlet-name\>).Examples.
Ten parametr jest skuteczny tylko wtedy, gdy pliki pomocy są zainstalowane na komputerze. Nie ma to wpływu na wyświetlanie pomocy koncepcyjnej (About_).
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
Examples
| Position: | Named |
| Obowiązkowe: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Full
Wyświetla cały artykuł pomocy dotyczący cmdlet. Full 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_).
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
AllUsersView
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Functionality
Wyświetla pomoc dotyczącą elementów z określoną funkcjonalnością. Wprowadź funkcjonalność. Symbole wieloznaczne są dozwolone. Ten parametr nie ma wpływu na wyświetlanie pomocy koncepcyjnej (About_).
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Name
Pobiera pomoc dotyczącą określonego polecenia lub koncepcji. Wprowadź nazwę polecenia cmdlet, funkcji, dostawcy, skryptu lub przepływu pracy, na przykład Get-Member, nazwę koncepcyjną artykułu, na przykład 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 środowiskowej $env:Path, wpisz ścieżkę skryptu i nazwę pliku.
Jeśli wprowadzisz dokładną nazwę artykułu pomocy, Get-Help wyświetli zawartość artykułu.
Jeśli wprowadzisz wzorzec słowa lub wyrazu, który pojawi się w kilku tytułach artykułu pomocy, Get-Help wyświetli listę pasujących tytułów.
Jeśli wprowadzisz słowo, które nie jest zgodne z żadnymi tytułami artykułów pomocy, Get-Help wyświetli listę artykułów zawierających ten wyraz 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.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | 0 |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
-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 cmdletów, funkcji, przepływów pracy i skryptów. Nie można użyć parametru Online z Get-Help w sesji zdalnej.
Aby uzyskać informacje na temat obsługi tej funkcji w artykułach pomocy, które piszesz, zobacz artykuły: about_Comment_Based_Help, Obsługa pomocy onlineoraz Tworzenie pomocy dotyczącej poleceń cmdlet programu PowerShell.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
Online
| Position: | Named |
| Obowiązkowe: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Parameter
Wyświetla tylko szczegółowe opisy określonych parametrów. Symbole wieloznaczne są dozwolone. Ten parametr nie ma wpływu na wyświetlanie pomocy koncepcyjnej (About_).
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
Parameters
| Position: | Named |
| Obowiązkowe: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Path
Otrzymuje pomoc wyjaśniającą, jak cmdlet działa w podanej ś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 cmdlet dostawcy i tylko wtedy, gdy dostawca zawiera niestandardową wersję artykułu pomocy cmdlet dostawcy w swoim pliku pomocy. Aby użyć tego parametru, zainstaluj plik pomocy dla modułu zawierającego dostawcę.
Aby wyświetlić niestandardową pomoc polecenia cmdlet dla ścieżki dostawcy, przejdź do lokalizacji ścieżki dostawcy i wprowadź polecenie Get-Help lub z dowolnej lokalizacji użyj parametru Ścieżka polecenia 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.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Role
Wyświetla pomoc dostosowaną dla określonej roli użytkownika. Wprowadź rolę. Symbole wieloznaczne są dozwolone.
Wprowadź rolę, jaką użytkownik odgrywa w organizacji. Niektóre polecenia cmdlet wyświetlają inny tekst w swoich plikach pomocy zależnie od wartości tego parametru. Ten parametr nie ma wpływu na pomoc dla podstawowych cmdletów.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-ShowWindow
Wyświetla temat pomocy w oknie, aby ułatwić czytanie. Okno zawiera funkcję wyszukiwania Znajdź oraz pole Ustawienia, które umożliwia ustawianie opcji wyświetlania, w tym opcji wyświetlania tylko wybranych sekcji tematu pomocy.
Parametr ShowWindow obsługuje tematy pomocy dla poleceń (poleceń cmdlet, funkcji, poleceń CIM, przepływów pracy, skryptów) i koncepcyjnych Informacje o artykułach. Nie obsługuje pomocy dostawcy.
Ten parametr został wprowadzony w programie PowerShell 3.0.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
ShowWindow
| Position: | Named |
| Obowiązkowe: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.
Dane wejściowe
None
Nie można wysyłać obiektów w dół potoku do Get-Help.
Dane wyjściowe
ExtendedCmdletHelpInfo
Jeśli uruchomisz Get-Help na poleceniu, 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 znaków.
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 polecenia cmdlet Update-Help. Możesz użyć polecenia cmdlet Update-Help, aby pobrać i zainstalować pliki pomocy dla podstawowych poleceń, które są dostarczane z programem 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 online w programie PowerShell, zaczynając od 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, Get-Help zachowuje się tak, jakby na komputerze nie ma żadnych plików pomocy. Aby uzyskać pomoc dotyczącą różnych ustawień regionalnych, użyj Region i Language w Panelu sterowania, aby zmienić ustawienia. W systemie Windows 10
Pełny widok pomocy zawiera tabelę informacji o parametrach. Tabela zawiera następujące pola:
wymagane. 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.
nazwane wskazuje, że nazwa parametru jest wymagana, ale parametr może pojawić się w dowolnym miejscu w poleceniu.
Numer wskazuje, że nazwa parametru jest opcjonalna, ale gdy nazwa zostanie pominięta, parametr musi być w miejscu określonym przez liczbę. Na przykład
2wskazuje, ż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 (true) lub nie można (false) wysyłać obiektów do parametru za pośrednictwem potoku. Według nazwy właściwości oznacza, że obiekt potokowy musi mieć właściwość o takiej samej nazwie jak nazwa parametru.
Akceptuje symbole wieloznaczne. Wskazuje, czy wartość parametru może zawierać symbole wieloznaczne, takie jak gwiazdka (
*) lub znak zapytania (?).