New-UsageInfo

Modul:
Microsoft.PowerShell.Crescendo Module

Létrehoz egy Crescendo-használati definíciót képviselő PowerShell-objektumot.

Syntax

Default (Alapértelmezett) 

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

Description

Important

2026 májusától a Crescendo projektet már nem tartják aktívan karban. Ezt a projektet mérnöki szempontból archiválottnak kell tekinteni.

Létrehoz egy Crescendo-használati definíciót képviselő PowerShell-objektumot. Az objektum tulajdonságaihoz értékeket rendelhet. Az eredményként kapott objektum hozzáadható egy parancsobjektum Használati tulajdonságához, vagy átalakítható JSON-ra, hogy beszúrható legyen a konfigurációs fájlba. Az objektum Synopsis a modulba a .SYNOPSIS kulcsszó alatt megjegyzésalapú súgóként van beszúrva.

Példák

1. példa – Használati objektum létrehozása és átalakítása JSON-ra

$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éterek

-usage

A parancsmag célját leíró szöveg.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:0
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

None

Kimenetek

Object