Freigeben über

New-UsageInfo

  • Referenz
Modul:
Microsoft.PowerShell.Crescendo

Erstellt ein PowerShell-Objekt, das eine Crescendo-Nutzungsdefinition darstellt.

Syntax

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

Beschreibung

Erstellt ein PowerShell-Objekt, das eine Crescendo-Nutzungsdefinition darstellt. Sie können den Eigenschaften des Objekts Werte zuweisen. Das resultierende Objekt kann der Usage-Eigenschaft eines Befehlsobjekts hinzugefügt oder in JSON konvertiert werden, um es in die Konfigurationsdatei einzufügen. Die Synopsis des Objekts wird in das Modul als kommentarbasierte Hilfe unter dem .SYNOPSIS Schlüsselwort (keyword) eingefügt.

Beispiele

Beispiel 1: Erstellen eines Usage-Objekts und Konvertieren in 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
}

Parameter

-usage

Der Text, der den Zweck des Cmdlets beschreibt.

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

Eingaben

None

Ausgaben

Object