psitem_témaismertető

Rövid leírás

Az automatikus változó, amely az aktuális objektumot tartalmazza a folyamatobjektumban.

Hosszú leírás

A PowerShell tartalmazza a $PSItem változót és annak aliasát, $_, mivel automatikus változók az aktuális objektumot feldolgozó szkriptblokkokban, például a folyamatban. Ez a cikk $PSItem használ a példákban, de $PSItem minden példában $_ helyettesíthető.

Ezt a változót olyan parancsokban használhatja, amelyek műveletet hajtanak végre egy folyamat minden objektumán.

A $PSItemnéhány gyakori használati esete van:

A parancsmag ForEach-Object paraméterének szkriptblokkjában
A parancsmag Where-Object paraméterének szkriptblokkjában
A belső módszerekben ForEach és Ahol
késleltetett kötésű scriptblock paraméterekkel
Egy switch utasítás feltételes értékeiben és a kapcsolódó szkriptblokkokban
Függvény process blokkjában
A filter definícióban
A ValidateScript attribútum szkriptblokkjában
Egy catch utasítás szkriptblokkjában
A -replace operátor helyettesítési operandus-szkriptblokkjában

A cikk további része példákat tartalmaz a $PSItem ilyen használati esetekhez való használatára.

ForEach-Object folyamat

Az ForEach-Object parancsmag úgy lett kialakítva, hogy a folyamat összes objektuma esetében végrehajtsa a Folyamat paraméter szkriptblokkját.

A(z) $PSItem a(z) folyamat paraméterének szkriptblokkjában használható, de nem a(z) Kezdés vagy Befejezés paraméterszkriptblokkokban. Ha a $PSItem-re hivatkozik a Begin vagy End szkriptblokkokban, az érték $null, mert ezek a szkriptblokkok nem hatnak a folyamat minden objektumára.

$parameters = @{
    Begin   = { Write-Host "PSItem in Begin is: $PSItem" }
    Process = {
        Write-Host "PSItem in Process is: $PSItem"
        $PSItem + 1
    }
    End     = { Write-Host "PSItem in End is: $PSItem" }
}

$result = 1, 2, 3 | ForEach-Object @parameters

Write-Host "Result is: $result"

PSItem in Begin is:
PSItem in Process is: 1
PSItem in Process is: 2
PSItem in Process is: 3
PSItem in End is:
Result is: 2 3 4

Where-Object FilterScript

A Where-Object parancsmag célja a folyamat objektumainak szűrése.

$PSItem-t a FilterScript paraméter szkriptblokkjában használhatja, amely a folyamatban minden bemeneti objektum esetén egyszer végrehajtódik.

1, 2, 3 | Where-Object -FilterScript { ($PSItem % 2) -eq 0 }

Ebben a példában a FilterScript ellenőrzi, hogy az aktuális objektum páros-e, kiszűri a páratlan értékeket, és csak 2 ad vissza az eredeti listából.

ForEach és Where metódusok

A ForEach és a Where belső metódusok bemeneti paraméterként egy skripttömböt fogadnak el. A szkriptblokkokban használhatja a $PSItem-t az aktuális objektum eléréséhez.

@('a', 'b', 'c').ForEach({ $PSItem.ToUpper() }).Where({ $PSItem -ceq 'B' })

Ebben a példában a ForEach metódus szkriptblokkja nagybetűssé alakítja az aktuális objektumot. Ezután a Where metódus szkriptblokkja csak Bad vissza.

Delay-bind ScriptBlock paraméterek

delay-bind scriptblocks lehetővé teszi, hogy $PSItem használatával definiálja a folyamatalapú parancsmag paramétereit a végrehajtás előtt.

dir config.log | Rename-Item -NewName { "old_$($_.Name)" }

Kapcsolóutasítás – ScriptBlocks

A kapcsolóutasításokban$PSItem műveletszkriptblokkokban és utasításállapot-szkriptblokkokban is használhatja.

$numbers = 1, 2, 3

switch ($numbers) {
    { ($PSItem % 2) -eq 0 } { "$PSItem is even" }
    default { "$PSItem is odd" }
}

1 is odd
2 is even
3 is odd

Ebben a példában az utasításfeltétel szkriptblokkja ellenőrzi, hogy az aktuális objektum páros-e. Ha páros, a társított műveleti szkriptblokk kiad egy üzenetet, amely azt mutatja, hogy az aktuális objektum páros.

A default feltétel műveletszkriptje egy üzenetet ad ki, amely jelzi, hogy az aktuális objektum páratlan.

Függvényfolyamat-blokkok

Ha függvénytdefiniál, $PSItem használhatja a process blokkdefinícióban, de a begin vagy end blokkdefiníciókban nem. Ha a $PSItem-ra hivatkozik a begin vagy end blokkokban, az érték $null, mert ezek a blokkok nem működnek a csővezeték egyes objektumain.

Ha a $PSItem-t használja a process blokkdefinícióban, az érték az aktuális objektum, ha a függvényt a csővezetékben hívják meg, és máskülönben $null.

function Add-One {
    process { $PSItem + 1 }
}

1, 2, 3 | Add-One

2
3
4

Borravaló

Habár $PSItem is használhatja, ennek nincs sok oka. Ha bemenetet szeretne kapni a folyamatból, a legjobb, ha a ValueFromPipeline* attribútum egyik argumentumával határoz meg paramétereket.

A Paraméter attribútum és parancsmag kötés speciális függvényekhez való használata explicitebbé és kiszámíthatóbbá teszi a megvalósítást, mint az aktuális objektum feldolgozása a szükséges értékek lekéréséhez.

A speciális függvényekben a $PSItem egyik jó használati módja az aktuális objektum saját magának megvizsgálása hibakeresés vagy naplózás céljából, ha a függvény több paramétert is használ, amelyek bemenetet vesznek fel a csővezetékből.

function Write-JsonLog {
    [CmdletBinding()]
    param(
        [Parameter(ValueFromPipelineByPropertyName)]
        [string]$Message
    )
    begin {
        $entries = @()
    }
    process {
        $entries += [pscustomobject]@{
            Message   = $Message
            TimeStamp = [datetime]::Now
        }

        if ($PSItem) {
            $props  = $PSItem | ConvertTo-Json
            $number = $entries.Length
            Write-Verbose "Input object $number is:`n$props"
        }
    }
    end {
        ConvertTo-Json -InputObject $entries
    }
}

Ez a példafüggvény JSON-objektumokból álló tömböt ad ki üzenettel és időbélyeggel. Amikor folyamatban hívják meg, az aktuális objektum Üzenet tulajdonságát használja minden egyes bejegyzéshez. Az aktuális objektum JSON-ábrázolását is a részletes adatfolyamba írja, így a kimeneti naplókhoz képest láthatja a tényleges bemenetet.

$Items = @(
    [pscustomobject]@{
        Name    = 'First Item'
        Message = 'A simple note'
    }
    [pscustomobject]@{
        Name    = 'Item with extra properties'
        Message = 'Missing message, has info instead'
        Info    = 'Some metadata'
        Source  = 'Where this came from'
    }
    [pscustomobject]@{
        Name    = 'Last Item'
        Message = 'This also gets logged'
    }
)

$Items | Write-JsonLog -Verbose

VERBOSE: Input object 1 is:
{
    "Name":  "First Item",
    "Message":  "A simple note"
}
VERBOSE: Input object 2 is:
{
    "Name":  "Item with extra properties",
    "Message":  "Missing message, has info instead",
    "Info":  "Some metadata",
    "Source":  "Where this came from"
}
VERBOSE: Input object 3 is:
{
    "Name":  "Last Item",
    "Message":  "This also gets logged"
}
[
    {
        "Message":  "A simple note",
        "TimeStamp":  "\/Date(1670344068257)\/"
    },
    {
        "Message":  "Missing message, has info instead",
        "TimeStamp":  "\/Date(1670344068259)\/"
    },
    {
        "Message":  "This also gets logged",
        "TimeStamp":  "\/Date(1670344068261)\/"
    }
]

Definíciók szűrése

A $PSItem egy szűrődefiníciójának utasításlistájában használhatja.

Amikor a $PSItem egy filter definícióban van használva, az érték az aktuális objektum, ha a szűrőt meghívják a csővezetékben, és egyébként $null.

filter Test-IsEven { ($PSItem % 2) -eq 0 }

1, 2, 3 | Test-IsEven

False
True
False

Ebben a példában a Test-IsEven szűrő kimenete $true, ha az aktuális objektum páros szám, és $false, ha nem.

A ValidateScript attribútum ScriptBlock

A $PSItem egy ValidateScript attribútum szkriptblokkjában használhatja. A ValidateScripthasználatakor a az aktuális érvényesítendő objektum értéke. Ha a változó vagy paraméter értéke tömb, a szkriptblokkot a tömb minden objektumához egyszer meghívja a $PSItem az aktuális objektumként.

function Add-EvenNumber {
    param(
        [ValidateScript({ 0 -eq ($PSItem % 2) })]
        [int[]]$Number
    )

    begin {
        [int]$total = 0
    }

    process {
        foreach ($n in $Number) {
            $total += $n
        }
    }

    end {
        $total
    }
}

Add-EvenNumber -Number 2, 4, 6

Add-EvenNumber -Number 1, 2

12

Add-EvenNumber:
Line |
  24 |  Add-EvenNumber -Number 1, 2
     |                         ~~~~
     | Cannot validate argument on parameter 'Number'. The
" 0 -eq ($PSItem % 2) " validation script for the argument
with value "1" did not return a result of True. Determine
why the validation script failed, and then try the command
again.

Ebben a példában a ValidateScript attribútum szkriptblokkja egyszer fut a Number paraméternek átadott összes értékhez, és hibát ad vissza, ha egy érték nem is egyenletes.

A Add-EvenNumber függvény hozzáadja az érvényes bemeneti számokat, és visszaadja a végösszeget.

A `catch` ScriptBlock utasítás

Egy catch blokkon belül az aktuális hiba $PSItemhasználatával érhető el. Az objektum Type ErrorRecord típusú.

try { NonsenseString }
catch {
    Write-Host "An error occurred:"
    Write-Host $_
}

A szkript futtatása a következő eredményt adja vissza:

An Error occurred:
The term 'NonsenseString' is not recognized as the name of a cmdlet, function,
script file, or operable program. Check the spelling of the name, or if a path
was included, verify that the path is correct and try again.

További példákért lásd a Kivételadatok elérése szakaszt about_Try_Catch_Finally.

Az `-replace` operátor helyettesítési ScriptBlockja

A PowerShell 6-tól kezdve használhatja a $PSItem a -replace operátor meghívásához és helyettesítési szkriptblokkdefiniálásakor. Ha ezt megteszi, a $PSItem értéke az aktuális egyezés értéke.

$datePattern = '\d{4}-\d{2}-\d{2}'
'Today is 1999-12-31' -replace $datePattern, { [datetime]$PSItem.Value }

Today is 12/31/1999 00:00:00

Ebben a példában a helyettesítési szkriptblokk az eredeti dátumsztringet az aktuális kultúra alapértelmezett formátumára cseréli úgy, hogy az értéket datetime.

Lásd még

Visszajelzés

Hasznosnak találta ezt az oldalt?

Last updated on 2025-09-29