Aracılığıyla paylaş

New-UsageInfo

Modül:
Microsoft.PowerShell.Crescendo Module

Crescendo Kullanım tanımını temsil eden bir PowerShell nesnesi oluşturur.

Sözdizimi

Default EnterprisePublishing 

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

Description

Crescendo Kullanım tanımını temsil eden bir PowerShell nesnesi oluşturur. Değerleri nesnenin özelliklerine atayabilirsiniz. Sonuçta elde edilen nesne, bir komut nesnesinin Usage özelliğine eklenebilir veya yapılandırma dosyasına eklenecek JSON'a dönüştürülebilir. Nesnenin Synopsis, .SYNOPSIS anahtar sözcüğü altında açıklama tabanlı yardım olarak modüle eklenir.

Örnekler

Örnek 1 - Kullanım nesnesi oluşturma ve bunu JSON'a dönüştürme

$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
}

Parametreler

-usage

Cmdlet'in amacını açıklayan metin.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:0
Zorunlu:True
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Girişler

None

Çıkışlar

Object