Sdílet prostřednictvím

New-UsageInfo

  • Reference
Modul:
Microsoft.PowerShell.Crescendo

Vytvoří objekt PowerShellu představující definici použití Crescendo.

Syntax

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

Description

Vytvoří objekt PowerShellu představující definici použití Crescendo. K vlastnostem objektu můžete přiřadit hodnoty. Výsledný objekt lze přidat do vlastnosti Usage objektu příkazu nebo ho lze převést na JSON a vložit do konfiguračního souboru. Synopse objektu se vloží do modulu jako nápověda založená na komentářích pod klíčovým slovem.SYNOPSIS.

Příklady

Příklad 1 – Vytvoření objektu Usage a jeho převod na 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
}

Parametry

-usage

Text popisující účel rutiny.

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

Vstupy

None

Výstupy

Object