Why is a leading comma required when creating an array?

by

@() is the array subexpression operator, which works differently than array construction operators you may be used to from other languages. The operator evaluates the nested subexpression and returns the output of that expression as an array. Meaning you can do something like this:

@(
Write-Output 'foo'
Get-Content 'C:\some\file.txt'
Test-Connection '192.168.23.42' -Count 1
)

and have an array come out.

For your first example this means that the two statements @(4, 1024) and , @((7), (16)) are evaluated individually, and the collective output of the two statements is then returned as an array.

The first statement (@(4, 1024)) outputs two integers, but the second statement (, @((7), (16))) outputs an array of two integers. That is because the leading comma in that statement is interpreted as the unary array construction operator (or comma operator), so you get an array nested in another array, and only the outer array is unrolled during output.

Essentially, your expression is the same as

$files1 = @(
4
1024
, @(7, 16)
)

or

$files1 = 4, 1024, @(7, 16)

Your second example avoids this pitfall, because both nested arrays are prepended with the unary array construction operator and thus protected from being completely unrolled.

With that said, I would recommend to define arrays in a more clear-cut way, e.g. like this:

$files1 = @(4, 1024),
          @(7, 16)

or (using grouping expressions instead of array subexpressions) like this:

$files1 = (4, 1024),
          (7, 16)

to avoid surprises like the one you observed. The outer @() isn’t necessary for defining an array here. PowerShell automatically detects that via the trailing comma at the end of the first line.

For further information see about_Operators.

More Related Contents:

  1. Not all properties displayed
  2. Select the values of one property on all objects of an array in PowerShell
  3. Comparing two arrays & get the values which are not common
  4. Objects with no ‘.Count’ Property – use of @() (array subexpression operator) vs. [Array] cast
  5. Get-ChildItem.Length is Wrong
  6. Array.Add vs +=
  7. How do I pass an array as a parameter to another script?
  8. Pipe complete array-objects instead of array items one at a time?
  9. PowerShell copy an array completely
  10. A cmdlet which returns multiple objects, what collection type is it, if any? [PowerShell]
  11. How to add hashtable to multidimensional array? Cannot assign values via member-access enumeration
  12. Data Rows to String to Array issue
  13. Create a Single-Element Json Array Object Using PowerShell
  14. Powershell: Piping output of pracl command to array
  15. Return Multidimensional Array From Function
  16. PowerShell array initialization
  17. How do I call New-Object for a constructor which takes a single array parameter?
  18. PowerShell doesn’t return an empty array as an array
  19. Getting “System.Collections.Generic.List`1[System.String]” in CSV File export when data is okay on screen
  20. How do I create array of arrays in PowerShell?
  21. Searching array reports “not found” even though it’s found
  22. How to iterate a loop with index and element in Swift
  23. MATLAB adding array elements iteratively: time behavior
  24. Sort Objects in Array by date
  25. How do I sort a swift array containing instances of NSManagedObject subclass by an attribute value (date)
  26. ReDim Preserve to a multi-dimensional array in VB6
  27. convert string to number array in matlab
  28. How to forward functions with variadic parameters?
  29. How do I Merge two Arrays in VBA?
  30. jq: recursively merge objects and concatenate arrays

Leave a Comment