New-UsageInfo
Crée un objet PowerShell représentant une définition d’utilisation Crescendo.
Syntaxe
Default (Par défaut)
New-UsageInfo
[-usage] <String>
[<CommonParameters>]
Description
Crée un objet PowerShell représentant une définition d’utilisation Crescendo. Vous pouvez affecter des valeurs aux propriétés de l’objet. L’objet résultant peut être ajouté à la propriété Utilisation d’un objet de commande, ou il peut être converti en JSON à insérer dans le fichier de configuration. Le Synopsis de l’objet est inséré dans le module en tant qu’aide basée sur les commentaires sous le mot clé .SYNOPSIS.
Exemples
Exemple 1 : Créer un objet Usage et le convertir en 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
}
Paramètres
-usage
Texte décrivant l’objectif de l’applet de commande.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
