Поделиться через

New-UsageInfo

  • Ссылка
Модуль:
Microsoft.PowerShell.Crescendo

Создает объект PowerShell, представляющий определение использования Crescendo.

Синтаксис

New-UsageInfo
   [-usage] <String>
   [<CommonParameters>]

Описание

Создает объект PowerShell, представляющий определение использования Crescendo. Можно назначить значения свойствам объекта. Полученный объект можно добавить в свойство Usage объекта команды или его можно преобразовать в JSON, чтобы вставить его в файл конфигурации. Synopsis объекта вставляется в модуль в качестве справки на основе комментариев в ключевое слово .SYNOPSIS.

Примеры

Пример 1. Создание объекта Usage и его преобразование в JSON

$usage = New-UsageInfo -usage 'This is a description for how to use the cmdlet.'
$usage | ConvertTo-Json

{
  "Synopsis": "This is a description for how to use the cmdlet.",
  "SupportsFlags": false,
  "HasOptions": false,
  "OriginalText": null
}

Параметры

-usage

Текст, описывающий назначение командлета.

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

None

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

Object