What does the "@" symbol do in PowerShell?

Viewed 145136

I've seen the @ symbol used in PowerShell to initialise arrays.

What exactly does the @ symbol denote and where can I read more about it?

6 Answers

In PowerShell V2, @ is also the Splat operator.

PS> # First use it to create a hashtable of parameters:
PS> $params = @{path = "c:\temp"; Recurse= $true}
PS> # Then use it to SPLAT the parameters - which is to say to expand a hash table 
PS> # into a set of command line parameters.
PS> dir @params
PS> # That was the equivalent of:
PS> dir -Path c:\temp -Recurse:$true

PowerShell will actually treat any comma-separated list as an array:

"server1","server2"

So the @ is optional in those cases. However, for associative arrays, the @ is required:

@{"Key"="Value";"Key2"="Value2"}

Officially, @ is the "array operator." You can read more about it in the documentation that installed along with PowerShell, or in a book like "Windows PowerShell: TFM," which I co-authored.

You can also wrap the output of a cmdlet (or pipeline) in @() to ensure that what you get back is an array rather than a single item.

For instance, dir usually returns a list, but depending on the options, it might return a single object. If you are planning on iterating through the results with a foreach-object, you need to make sure you get a list back. Here's a contrived example:

$results = @( dir c:\autoexec.bat)

One more thing... an empty array (like to initialize a variable) is denoted @().

I hope this helps to understand it a bit better. You can store "values" within a key and return that value to do something. In this case I have just provided @{a="";b="";c="";} and if not in the options i.e "keys" (a, b or c) then don't return a value

$array = @{
a = "test1";
b = "test2";
c = "test3"
}

foreach($elem in $array.GetEnumerator()){
    if ($elem.key -eq "a"){
        $key = $elem.key
        $value = $elem.value
    }
    elseif ($elem.key -eq "b"){
        $key = $elem.key
        $value = $elem.value
    }
    elseif ($elem.key -eq "c"){
        $key = $elem.key
        $value = $elem.value
    }
    else{
        Write-Host "No other value"
    }

    Write-Host "Key: " $key "Value: " $value 
}
Related