Dela via

New-UsageInfo

  • Referens
Modul:
Microsoft.PowerShell.Crescendo

Skapar ett PowerShell-objekt som representerar en definition av crescendoanvändning.

Syntax

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

Description

Skapar ett PowerShell-objekt som representerar en definition av crescendoanvändning. Du kan tilldela värden till objektets egenskaper. Det resulterande objektet kan läggas till i egenskapen Usage för ett kommandoobjekt eller konverteras till JSON för att infogas i konfigurationsfilen. Objektets Synopsis- infogas i modulen som kommentarsbaserad hjälp under nyckelordet .SYNOPSIS.

Exempel

Exempel 1 – Skapa ett användningsobjekt och konvertera det till 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
}

Parametrar

-usage

Texten som beskriver syftet med cmdleten.

Typ:String
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

None

Utdata

Object