Show-Command

Ссылка

Модуль:: Microsoft.PowerShell.Utility

Отображает сведения о команде PowerShell в графическом окне.

Синтаксис

Show-Command
    [[-Name] <String>]
    [-Height <Double>]
    [-Width <Double>]
    [-NoCommonParameter]
    [-ErrorPopup]
    [-PassThru]
    [<CommonParameters>]

Описание

Этот командлет доступен только на платформе Windows.

Командлет Show-Command позволяет создать команду PowerShell в командном окне. Эту функцию командного окна можно использовать для запуска или возврата команды.

Show-Command — это очень полезное средство обучения и обучения. Show-Command работает со всеми типами команд, включая командлеты, функции, рабочие процессы и команды CIM.

Без параметров отображается окно команд, Show-Command в котором перечислены все доступные команды во всех установленных модулях. Чтобы найти команды в модуле, выберите модуль в соответствующем раскрывающемся списке. Чтобы выбрать команду, щелкните имя команды.

Чтобы использовать командное окно, выберите команду, используя имя или щелкнув имя команды в списке команд . Каждый набор параметров отображается на отдельной вкладке. Звездочки указывают обязательные параметры. Чтобы ввести значение для параметра, введите значение в текстовое поле или выберите его из раскрывающегося списка. Чтобы добавить параметр переключателя, установите флажок параметра.

Когда вы будете готовы, нажмите кнопку "Копировать ", чтобы скопировать созданную команду в буфер обмена или нажать кнопку "Выполнить ", чтобы выполнить команду. Вы также можете использовать параметр PassThru , чтобы вернуть команду в хост-программу, например консоль PowerShell. Чтобы отменить выделение команды и вернуться в представление, отображающее все команды, нажмите клавиши CTRL и щелкните выбранную команду.

В интегрированной среде сценариев PowerShell (ISE) по умолчанию отображается вариант Show-Command окна. Сведения об использовании этого командного окна см. в разделах справки по isE PowerShell.

Этот командлет был повторно введен в PowerShell 7.

Так как для этого командлета требуется пользовательский интерфейс, он не работает в Windows Server Core или Windows Nano Server. Этот командлет доступен только в системах Windows, поддерживающих рабочий стол Windows.

Примеры

Пример 1. Открытие окна команд

В этом примере отображается представление Show-Command окна по умолчанию. В окне "Команды" отображается список всех команд во всех модулях, установленных на компьютере.

Show-Command

Пример 2. Открытие командлета в окне "Команды"

В этом примере отображается Invoke-Command командлет в окне командной строки . Это отображение можно использовать для выполнения Invoke-Command команд.

Show-Command -Name "Invoke-Command"

Пример 3. Открытие командлета с указанными параметрами

Эта команда открывает Show-Command окно для командлетаConnect-PSSession.

Show-Command -Name "Connect-PSSession" -Height 700 -Width 1000 -ErrorPopup

Параметры высоты и ширины указывают измерение командного окна. Параметр ErrorPopup отображает окно команды ошибки.

При нажатии кнопки "Выполнить" команда выполняется так же, Connect-PSSession как если бы вы ввели Connect-PSSession команду в командной строке.

Пример 4. Указание новых значений параметров по умолчанию для командлета

В этом примере используется автоматическая $PSDefaultParameterValues переменная для задания новых значений по умолчанию для параметров Height, Width и ErrorPopup командлета Show-Command .

$PSDefaultParameterValues = @{
    "Show-Command:Height" = 700
    "Show-Command:Width" = 1000
    "Show-Command:ErrorPopup" = $True
}

Теперь при выполнении Show-Command команды новые значения по умолчанию применяются автоматически. Чтобы использовать эти значения по умолчанию в каждом сеансе PowerShell, добавьте $PSDefaultParameterValues переменную в профиль PowerShell. Дополнительные сведения см. в about_Profiles и about_Parameters_Default_Values.

Пример 5. Отправка выходных данных в представление сетки

Эта команда показывает, как совместно использовать Show-Command командлеты и Out-GridView командлеты.

Show-Command Get-ChildItem | Out-GridView

Команда использует Show-Command командлет для открытия командного окна для командлетаGet-ChildItem. При нажатии кнопки Get-ChildItem "Выполнить" команда запускается и создает выходные данные. Оператор конвейера (|) отправляет выходные данные команды Out-GridView командлету, который отображает Get-ChildItem выходные данные Get-ChildItem в интерактивном окне.

Пример 6. Отображение команды, создаваемой в окне "Команды"

В этом примере показана команда, созданная в Show-Command окне. Команда использует параметр PassThru , который возвращает Show-Command результаты в строке.

Show-Command -PassThru

Get-EventLog -LogName "Windows PowerShell" -Newest 5

Например, если вы используете Show-Command окно для создания Get-EventLog команды, которая получает пять новых событий в журнале событий Windows PowerShell, а затем нажмите кнопку "ОК", команда возвращает выходные данные, показанные выше. Просмотр командной строки поможет вам узнать PowerShell.

Пример 7. Сохранение команды в переменной

В этом примере показано, как запустить командную строку, которую вы получаете при использовании параметра PassThru командлета Show-Command . Эта стратегия позволяет видеть команду и использовать ее.

$C = Show-Command -PassThru
$C
Invoke-Expression $C

Get-EventLog -LogName "PowerShell" -Newest 5

Index Time          EntryType   Source                 InstanceID Message
----- ----          ---------   ------                 ---------- -------
11520 Dec 16 16:37  Information Windows PowerShell            400 Engine state is changed from None to Available...
11519 Dec 16 16:37  Information Windows PowerShell            600 Provider "Variable" is Started. ...
11518 Dec 16 16:37  Information Windows PowerShell            600 Provider "Registry" is Started. ...
11517 Dec 16 16:37  Information Windows PowerShell            600 Provider "Function" is Started. ...
11516 Dec 16 16:37  Information Windows PowerShell            600 Provider "FileSystem" is Started. ...

Первая команда использует параметр PassThru командлета Show-Command и сохраняет результаты команды в переменной $C . В этом случае мы используем Show-Command окно для создания Get-EventLog команды, которая получает пять новых событий в журнале событий Windows PowerShell. При нажатии кнопки ОКShow-Command возвращает командную строку, которая сохраняется в переменной$C.

Пример 8. Сохранение выходных данных команды в переменной

В этом примере используется параметр ErrorPopup для сохранения выходных данных команды в переменной.

$P = Show-Command Get-Process -ErrorPopup
$P

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    473      33    94096     112532   709     2.06   4492 powershell

Помимо отображения ошибок в окне, ErrorPopup возвращает выходные данные команд в текущую команду вместо создания новой команды. При выполнении Show-Command этой команды откроется окно. Функции окна можно использовать для установки значений параметров. Чтобы выполнить команду, нажмите кнопку "Запустить " в Show-Command окне.

Параметры

-ErrorPopup

Указывает, что командлет отображает ошибки во всплывающем окне, а также отображает их в командной строке. По умолчанию при выполнении команды в Show-Command окне возникает ошибка, ошибка отображается только в командной строке.

Кроме того, при выполнении команды (с помощью кнопки "Выполнить " в Show-Command окне) параметр ErrorPopup возвращает результаты команды текущей команде, а не при выполнении команды и возврате выходных данных в новую команду. Эту функцию можно использовать для сохранения результатов команды в переменной.

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

-Height

Указывает высоту Show-Command окна в пикселях. Введите значение в диапазоне от 300 пикселей до числа пикселей разрешения экрана. Если значение слишком велико для отображения окна команды на экране, Show-Command возникает ошибка. Высота по умолчанию: 600 пикселей. Show-Command Для команды, включающей параметр Name, высота по умолчанию составляет 300 пикселей.

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

-Name

Отображает командное окно для заданной команды. Введите имя одной команды, например имя командлета, функции или команды CIM. Если этот параметр не указан, отобразится окно командной строки, Show-Command в котором перечислены все команды PowerShell во всех модулях, установленных на компьютере.

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

-NoCommonParameter

Указывает, что этот командлет пропускает раздел "Общие параметры" в отображении команды. По умолчанию общие параметры отображаются в развертываемом разделе в нижней части командного окна.

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

-PassThru

Возвращает объект, представляющий элемент, с которым вы работаете. По умолчанию этот командлет не создает выходные данные. Чтобы запустить командную строку, скопируйте и вставьте ее в командную строку или сохраните ее в переменной и используйте Invoke-Expression командлет для запуска строки в переменной.

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

-Width

Задает ширину Show-Command окна в пикселях. Введите значение в диапазоне от 300 пикселей до числа пикселей разрешения экрана. Если значение слишком велико для отображения окна команды на экране, Show-Command возникает ошибка. Ширина по умолчанию: 300 пикселей.

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

Входные данные

None

Невозможно передать объекты в этот командлет.

Выходные данные

None

По умолчанию этот командлет не возвращает выходные данные.

String

При использовании параметра PassThru этот командлет возвращает командную строку.

Object

При использовании параметра ErrorPopup этот командлет возвращает выходные данные команды (любой объект).

Примечания

PowerShell включает следующие псевдонимы для Show-Command:

Windows:
- shcm

Этот командлет доступен только на платформах Windows.

Show-Command не работает в удаленных сеансах.