about_Functions_CmdletBindingAttribute

Kısa açıklama

bir işlevin derlenmiş bir cmdlet gibi çalışmasını sağlayan özniteliği açıklar.

Uzun açıklama

CmdletBinding özniteliği, C# dilinde yazılmış derlenmiş cmdlet'ler gibi çalışmalarına neden olan işlevlerin özniteliğidir. Cmdlet'lerin özelliklerine erişim sağlar.

CmdletBinding özniteliğini kullandığınızda PowerShell, Ortak Parametreleri otomatik olarak ekler. Common Parameters ile aynı adları kullanan hiçbir parametre oluşturamazsınız. Daha fazla bilgi için bkz. about_CommonParameters.

PowerShell, CmdletBinding özniteliğine sahip işlevlerin parametrelerini, derlenmiş cmdlet'lerin parametrelerini bağlayabilecek şekilde bağlar. $PSCmdlet otomatik değişkeni, CmdletBinding özniteliğine sahip işlevler tarafından kullanılabilir, ancak $args değişkeni kullanılamaz.

CmdletBinding özniteliğine sahip işlevlerde, eşleşen konumsal parametresi olmayan bilinmeyen parametreler ve konumsal bağımsız değişkenler parametre bağlamanın başarısız olmasına neden olur.

Not

Derlenmiş cmdlet'ler, bu konuda açıklanan Cmdlet özniteliğine benzer olan gerekli CmdletBinding özniteliğini kullanır.

Sözdizimi

Aşağıdaki örnek, CmdletBinding özniteliğinin tüm isteğe bağlı bağımsız değişkenlerini belirten bir işlevin biçimini gösterir. Her bağımsız değişkenin kısa bir açıklaması bu örneği izler.

{
    [CmdletBinding(ConfirmImpact=<String>,
    DefaultParameterSetName=<String>,
    HelpUri=<URI>,
    SupportsPaging=<Boolean>,
    SupportsShouldProcess=<Boolean>,
    PositionalBinding=<Boolean>)]

    param ($Parameter1)
    begin {}
    process {}
    end {}
}

CmdletBinding özniteliğinin boole bağımsız değişkeni türleri, CmdletBinding özniteliğinden atlandığında varsayılan olarak False olarak ayarlanır. Bağımsız değişken değerini $true olarak ayarlayın veya yalnızca bağımsız değişkeni ada göre listeleyin. Örneğin, aşağıdaki CmdletBinding öznitelikleri eşdeğerdir.

{
    [CmdletBinding(SupportsPaging=$true)]

    param ($Parameter1)
    begin {}
    process {}
    end {}
}

# Boolean arguments can be defined using this shorthand syntax

{
    [CmdletBinding(SupportsPaging)]

    param ($Parameter1)
    begin {}
    process {}
    end {}
}

ConfirmImpact

ConfirmImpact bağımsız değişkeni, işlevin eyleminin ShouldProcess yöntemine yapılan bir çağrıyla ne zaman doğrulanması gerektiğini belirtir. ShouldProcess yöntemine yapılan çağrı, yalnızca ConfirmImpact bağımsız değişkeni $ConfirmPreference tercih değişkeninin değerine eşit veya ondan büyük olduğunda bir onay istemi görüntüler. (Bağımsız değişkenin varsayılan değeri Orta .) Bu bağımsız değişkeni yalnızca SupportsShouldProcess bağımsız değişkeni de belirtildiğinde belirtin.

Onay istekleri hakkında daha fazla bilgi için bkz. onay isteği .

DefaultParameterSetName

DefaultParameterSetName bağımsız değişkeni, Hangi parametre kümesinin kullanılacağını belirleyemediğinde PowerShell'in kullanmayı deneyeceği parametre kümesinin adını belirtir. Her parametre kümesinin benzersiz parametresini zorunlu bir parametre yaparak bu sorundan kaçınabilirsiniz.

HelpUri

HelpUri bağımsız değişkeni, yardım konusunun işlevini açıklayan çevrimiçi sürümünün internet adresini belirtir. HelpUri bağımsız değişkeninin değeri "http" veya "https" ile başlamalıdır.

HelpUri bağımsız değişken değeri, işlevi için döndürdüğü CommandInfo nesnesinin Get-Command özelliğinin değeri için kullanılır.

Ancak, yardım dosyaları bilgisayara yüklendiğinde ve yardım dosyasının RelatedLinks bölümündeki ilk bağlantının değeri bir URI olduğunda veya açıklama tabanlı yardımdaki ilk .LINK anahtar sözcüğün değeri bir URI olduğunda, yardım dosyasındaki URI işlevin HelpUri özelliğinin değeri olarak kullanılır.

Get-Help cmdlet'i, Online parametresi bir komutta belirtildiğinde işlev yardım konusunun çevrimiçi sürümünü bulmak için Get-Help özelliğinin değerini kullanır.

SupportsPaging

SupportsPaging bağımsız değişkeni, first, Skipve IncludeTotalCount parametrelerini işleve ekler. Bu parametreler kullanıcıların çok büyük bir sonuç kümesinden çıktı seçmesine olanak sağlar. Bu bağımsız değişken, SQL veritabanı gibi veri seçimini destekleyen büyük veri depolarından veri döndüren cmdlet'ler ve işlevler için tasarlanmıştır.

Bu bağımsız değişken Windows PowerShell 3.0'da kullanıma sunulmuştur.

İlk: Yalnızca ilk 'n' nesnelerini alır.
Atla: İlk 'n' nesneleri yoksayar ve kalan nesneleri alır.
IncludeTotalCount: Veri kümesindeki nesne sayısını (bir tamsayı) ve ardından nesneleri bildirir. Cmdlet toplam sayıyı belirleyemezse, "Bilinmeyen toplam sayısı" döndürür.

PowerShell, döndürülecek toplam sayı değerini alan ve toplam sayı değerinin doğruluğuna ilişkin bir tahmin içeren bir yardımcı yöntem olan NewTotalCount içerir.

Aşağıdaki örnek işlev, gelişmiş bir işleve disk belleği parametreleri için nasıl destek ekleneceğini gösterir.

function Get-Numbers {
    [CmdletBinding(SupportsPaging)]
    param()

    $FirstNumber = [Math]::Min($PSCmdlet.PagingParameters.Skip, 100)
    $LastNumber = [Math]::Min($PSCmdlet.PagingParameters.First +
      $FirstNumber - 1, 100)

    if ($PSCmdlet.PagingParameters.IncludeTotalCount) {
        $TotalCountAccuracy = 1.0
        $TotalCount = $PSCmdlet.PagingParameters.NewTotalCount(100,
          $TotalCountAccuracy)
        Write-Output $TotalCount
    }
    $FirstNumber .. $LastNumber | Write-Output
}

SupportsShouldProcess

SupportsShouldProcess bağımsız değişkeni Confirm ve WhatIf parametrelerini işleve ekler. Confirm parametresi, işlem hattındaki her nesnede komutu çalıştırmadan önce kullanıcıya sorar. WhatIf parametresi, komutu çalıştırmak yerine komutun yapacağı değişiklikleri listeler.

PositionalBinding

PositionalBinding bağımsız değişkeni, işlevdeki parametrelerin varsayılan olarak konumlu olup olmadığını belirler. Varsayılan değer $true. Konumsal bağlamayı devre dışı bırakmak için PositionalBinding bağımsız değişkenini $false değeriyle kullanabilirsiniz.

PositionalBinding bağımsız değişkeni Windows PowerShell 3.0'da kullanıma sunulmuştur.

Parametreler konumsal olduğunda, parametre adı isteğe bağlıdır. PowerShell, işlev komutundaki adlandırılmamış parametre değerlerinin sırasına veya konumuna göre adsız parametre değerlerini işlev parametreleriyle ilişkilendirir.

Parametreler konumsal olmadığında ("adlandırılmış") parametre adı (veya adın kısaltması veya diğer adı) komutunda gereklidir.

PositionalBinding$trueolduğunda, işlev parametreleri varsayılan olarak konumsaldır. PowerShell, parametrelere işlevde bildirildiği sırayla konum numarası atar.

PositionalBinding$falseolduğunda, işlev parametreleri varsayılan olarak konumsal değildir. parametrede Parameter özniteliğinin Position bağımsız değişkeni bildirilmediği sürece, parametre işlevinde kullanıldığında parametre adı (veya diğer ad veya kısaltma) dahil edilmelidir.

Parameter özniteliğinin Position bağımsız değişkeni, PositionalBinding varsayılan değerinden önceliklidir. Konum bağımsız değişkenini kullanarak parametre için konum değeri belirtebilirsiniz. Konum bağımsız değişkeni hakkında daha fazla bilgi için bkz. about_Functions_Advanced_Parameters.

Notes

SupportsTransactions bağımsız değişkeni gelişmiş işlevlerde desteklenmez.

Anahtar sözcükler

about_Functions_CmdletBinding_Attribute

Ayrıca bakınız

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2025-02-05