Update-List (Microsoft.PowerShell.Utility)

Update-List

向包含对象集合的属性值添加项目或从中删除项目。

句法

Update-List
      [-Add <Object[]>]
      [-Remove <Object[]>]
      [-InputObject <PSObject>]
      [[-Property] <String>]
      [<CommonParameters>]

Update-List
      -Replace <Object[]>
      [-InputObject <PSObject>]
      [[-Property] <String>]
      [<CommonParameters>]

描述

Update-List cmdlet 添加、删除或替换对象属性值中的项目并返回更新后的对象。此 cmdlet 专为包含对象集合的属性而设计。

添加和删除参数将单个项目添加到集合中或将其从集合中删除。 替换参数会替换整个集合。

如果您未在命令中指定属性，Update-List 将返回一个描述更新的哈希表，而不是更新对象。稍后，您可以使用此更改集来更新列表对象。

仅当要更新的属性支持 Update-List 使用的 IList 接口时，此 cmdlet 才有效。此外，任何接受更新的 Set cmdlet 都必须支持 IList 接口。

此 cmdlet 在 PowerShell 7 中重新引入。

示例

示例 1：将项目添加到属性值

在此示例中，我们创建一个表示一副纸牌的类，其中纸牌存储为 List 集合对象。 NewDeck() 方法使用 Update-List 将一副完整的牌值添加到 cards 集合中。

class Cards {

    [System.Collections.Generic.List[string]]$cards
    [string]$name

    Cards([string]$_name) {
        $this.name = $_name
        $this.cards = [System.Collections.Generic.List[string]]::new()
    }

    NewDeck() {
        $_suits = "`u{2663}","`u{2666}","`u{2665}","`u{2660}"
        $_values = 'A',2,3,4,5,6,7,8,9,10,'J','Q','K'
        $_deck = foreach ($s in $_suits){ foreach ($v in $_values){ "$v$s"} }
        $this | Update-List -Property cards -Add $_deck | Out-Null
    }

    Show() {
        Write-Host
        Write-Host $this.name ": " $this.cards[0..12]
        if ($this.cards.count -gt 13) {
            Write-Host (' ' * ($this.name.length+3)) $this.cards[13..25]
        }
        if ($this.cards.count -gt 26) {
            Write-Host (' ' * ($this.name.length+3)) $this.cards[26..38]
        }
        if ($this.cards.count -gt 39) {
            Write-Host (' ' * ($this.name.length+3)) $this.cards[39..51]
        }
    }

    Shuffle() { $this.cards = Get-Random -InputObject $this.cards -Count 52 }

    Sort() { $this.cards.Sort() }
}

笔记

Update-List cmdlet 将更新的对象输出到管道。我们将输出通过管道传输到 Out-Null 以抑制不需要的显示。

示例 2：添加和删除集合属性的项目

继续示例 1 中的代码，我们将创建 Cards 类的实例来表示一副牌和两个玩家持有的牌。我们使用 Update-List cmdlet 将牌添加到玩家的手上以及从牌组中删除牌。

$player1 = [Cards]::new('Player 1')
$player2 = [Cards]::new('Player 2')

$deck = [Cards]::new('Deck')
$deck.NewDeck()
$deck.Shuffle()
$deck.Show()

# Deal two hands
$player1 | Update-List -Property cards -Add $deck.cards[0,2,4,6,8] | Out-Null
$player2 | Update-List -Property cards -Add $deck.cards[1,3,5,7,9] | Out-Null
$deck | Update-List -Property cards -Remove $player1.cards | Out-Null
$deck | Update-List -Property cards -Remove $player2.cards | Out-Null

$player1.Show()
$player2.Show()
$deck.Show()

Deck :  4♦ 7♥ J♦ 5♣ A♣ 8♦ J♣ Q♥ 6♦ 3♦ 9♦ 6♣ 2♣
        K♥ 4♠ 10♥ 8♠ 10♦ 9♠ 6♠ K♦ 7♣ 3♣ Q♣ A♥ Q♠
        3♥ 5♥ 2♦ 5♠ J♥ J♠ 10♣ 4♥ Q♦ 10♠ 4♣ 2♠ 2♥
        6♥ 7♦ A♠ 5♦ 8♣ 9♥ K♠ 7♠ 3♠ 9♣ A♦ K♣ 8♥

Player 1 :  4♦ J♦ A♣ J♣ 6♦

Player 2 :  7♥ 5♣ 8♦ Q♥ 3♦

Deck :  9♦ 6♣ 2♣ K♥ 4♠ 10♥ 8♠ 10♦ 9♠ 6♠ K♦ 7♣ 3♣
        Q♣ A♥ Q♠ 3♥ 5♥ 2♦ 5♠ J♥ J♠ 10♣ 4♥ Q♦ 10♠
        4♣ 2♠ 2♥ 6♥ 7♦ A♠ 5♦ 8♣ 9♥ K♠ 7♠ 3♠ 9♣
        A♦ K♣ 8♥

输出显示了牌发给玩家之前牌组的状态。您可以看到每位玩家从牌堆中收到了五张牌。最终输出显示向玩家发牌后牌组的状态。 Update-List 用于从牌组中选择卡牌并将其添加到玩家的收藏中。然后使用 Update-List 将玩家的牌从牌组中移除。

示例 3：在单个命令中添加和删除项目

Update-List 允许您在单个命令中使用添加 和删除 参数。在此示例中，玩家 1 想要丢弃4♦ 和6♦ 并获得两张新牌。

# Player 1 wants two new cards - remove 2 cards & add 2 cards
$player1 | Update-List -Property cards -Remove $player1.cards[0,4] -Add $deck.cards[0..1] | Out-Null
$player1.Show()

# remove dealt cards from deck
$deck | Update-List -Property cards -Remove $deck.cards[0..1] | Out-Null
$deck.Show()

Player 1 :  J♦ A♣ J♣ 9♦ 6♣

Deck :  2♣ K♥ 4♠ 10♥ 8♠ 10♦ 9♠ 6♠ K♦ 7♣ 3♣ Q♣ A♥
        Q♠ 3♥ 5♥ 2♦ 5♠ J♥ J♠ 10♣ 4♥ Q♦ 10♠ 4♣ 2♠
        2♥ 6♥ 7♦ A♠ 5♦ 8♣ 9♥ K♠ 7♠ 3♠ 9♣ A♦ K♣
        8♥

示例 4：将更改集应用于列表对象

如果您未指定属性，Update-List 将返回一个描述更新的哈希表，而不是更新对象。您可以将哈希表转换为 System.PSListModifier 对象，并使用 ApplyTo() 方法将更改集应用到列表。

$list = [System.Collections.ArrayList] (1, 43, 2)
$changeInstructions = Update-List -Remove 43 -Add 42
$changeInstructions

Name                           Value
----                           -----
Add                            {42}
Remove                         {43}

([PSListModifier]($changeInstructions)).ApplyTo($list)
$list

1
2
42

参数

-Add

指定要添加到集合中的属性值。按照值应在集合中出现的顺序输入值。

Object[]

命名

None

False

False

False

-InputObject

指定要更新的对象。您还可以将要更新的对象通过管道传送到Update-List。

PS对象

命名

None

False

True

False

-Property

指定包含正在更新的集合的属性。如果省略此参数，Update-List 将返回一个表示更改的对象，而不是更改该对象。

String

0

None

False

False

False

-Remove

指定要从集合中删除的属性值。

Object[]

命名

None

False

False

False

-Replace

指定一个新集合。此参数将原始集合中的所有项目替换为此参数指定的项目。

Object[]

命名

None

True

False

False

输入

PSObject

您可以通过管道将要更新的对象传递到此 cmdlet。

输出

哈希表

默认情况下，此 cmdlet 返回描述更新的哈希表。

对象

当您指定 Property 参数时，此 cmdlet 将返回更新的对象。