New-UsageInfo
Cria um objeto do PowerShell que representa uma definição de Uso crescendo.
Sintaxe
Default (Default)
New-UsageInfo
[-usage] <String>
[<CommonParameters>]
Description
Importante
Em maio de 2026, o projeto Crescendo não está mais sendo mantido ativamente. Este projeto deve ser considerado arquivado do ponto de vista da engenharia.
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 de Sinopse do objeto é inserida no módulo como ajuda baseada em comentários na palavra-chave .SYNOPSIS.
Exemplos
Exemplo 1 – Criar um objeto de uso 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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
