Partager via

New-UsageInfo

  • Référence
Module:
Microsoft.PowerShell.Crescendo

Crée un objet PowerShell représentant une définition d’utilisation Crescendo.

Syntax

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é Usage d’un objet de commande ou il peut être converti en JSON pour être inséré dans le fichier de configuration. Le Synopsis de l’objet est inséré dans le module en tant qu’aide basée sur des commentaires sous la .SYNOPSIS mot clé.

Exemples

Exemple 1 - Créer un objet Usage et le convertir au format 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.

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

Entrées

None

Sorties

Object