Compartilhar via

New-UsageInfo

  • Referência
Módulo:
Microsoft.PowerShell.Crescendo

Cria um objeto do PowerShell que representa uma definição de Uso crescendo.

Syntax

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

Description

Cria um objeto do PowerShell que representa uma definição de Uso crescendo. Você pode atribuir valores às propriedades do objeto . O objeto resultante pode ser adicionado à propriedade Usage de um objeto de comando ou pode ser convertido em JSON para ser inserido no arquivo de configuração. A sinopse do objeto é inserida no módulo como ajuda baseada em comentários no .SYNOPSIS palavra-chave.

Exemplos

Exemplo 1 – Criar um objeto Usage e convertê-lo em 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
}

Parâmetros

-usage

O texto que descreve a finalidade do cmdlet.

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

Entradas

None

Saídas

Object