Udostępnij za pośrednictwem

New-UsageInfo

  • Odwołanie
Moduł:
Microsoft.PowerShell.Crescendo

Tworzy obiekt programu PowerShell reprezentujący definicję użycia crescendo.

Składnia

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

Opis

Tworzy obiekt programu PowerShell reprezentujący definicję użycia crescendo. Wartości można przypisać do właściwości obiektu. Wynikowy obiekt można dodać do właściwości Usage obiektu polecenia lub można go przekonwertować na kod JSON, który ma zostać wstawiony w pliku konfiguracji. Synopsis obiektu jest wstawiany w module jako pomoc oparta na komentarzach w ramach słowa kluczowego .SYNOPSIS.

Przykłady

Przykład 1 — tworzenie obiektu Użycia i konwertowanie go na 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
}

Parametry

-usage

Tekst opisujący przeznaczenie polecenia cmdlet.

Typ:String
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

None

Dane wyjściowe

Object