.NET Framework Class Library
Enumerable..::.ToArray<(Of <(TSource>)>) Method

Creates an array from a IEnumerable<(Of <(T>)>).

Namespace:  System.Linq
Assembly:  System.Core (in System.Core.dll)
Syntax

Visual Basic (Declaration)
<ExtensionAttribute> _
Public Shared Function ToArray(Of TSource) ( _
    source As IEnumerable(Of TSource) _
) As TSource()
Visual Basic (Usage)
Dim source As IEnumerable(Of TSource)
Dim returnValue As TSource()

returnValue = source.ToArray()
C#
public static TSource[] ToArray<TSource>(
    this IEnumerable<TSource> source
)
Visual C++
[ExtensionAttribute]
public:
generic<typename TSource>
static array<TSource>^ ToArray(
    IEnumerable<TSource>^ source
)
JScript
JScript does not support generic types or methods.

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Collections.Generic..::.IEnumerable<(Of <(TSource>)>)
An IEnumerable<(Of <(T>)>) to create an array from.

Return Value

Type: array<TSource>[]()[]
An array that contains the elements from the input sequence.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<(Of <(TSource>)>). When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions

ExceptionCondition
ArgumentNullException

source is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

The ToArray<(Of <(TSource>)>)(IEnumerable<(Of <(TSource>)>)) method forces immediate query evaluation and returns an array that contains the query results. You can append this method to your query in order to obtain a cached copy of the query results.

ToList<(Of <(TSource>)>) has similar behavior but returns a List<(Of <(T>)>) instead of an array.

Examples

The following code example demonstrates how to use ToArray<(Of <(TSource>)>) to force immediate query evaluation and return an array of results.

Visual Basic
Structure Package
    Public Company As String
    Public Weight As Double
End Structure

Sub ToArrayEx1()
    ' Create a list of Package values.
    Dim packages As New List(Of Package)(New Package() _
         {New Package With {.Company = "Coho Vineyard", .Weight = 25.2}, _
          New Package With {.Company = "Lucerne Publishing", .Weight = 18.7}, _
          New Package With {.Company = "Wingtip Toys", .Weight = 6.0}, _
          New Package With {.Company = "Adventure Works", .Weight = 33.8}})

    ' Project the Company values from each item in the list
    ' and put them into an array.
    Dim companies() As String = _
        packages _
        .Select(Function(pkg) pkg.Company) _
        .ToArray()

    ' Display the results.
    Dim output As New System.Text.StringBuilder
    For Each company As String In companies
        output.AppendLine(company)
    Next
    MsgBox(output.ToString())
End Sub

' This code produces the following output:
'
' Coho Vineyard
' Lucerne Publishing
' Wingtip Toys
' Adventure Works

C#
class Package
{
    public string Company { get; set; }
    public double Weight { get; set; }
}

public static void ToArrayEx1()
{
    List<Package> packages =
        new List<Package> 
            { new Package { Company = "Coho Vineyard", Weight = 25.2 },
              new Package { Company = "Lucerne Publishing", Weight = 18.7 },
              new Package { Company = "Wingtip Toys", Weight = 6.0 },
              new Package { Company = "Adventure Works", Weight = 33.8 } };

    string[] companies = packages.Select(pkg => pkg.Company).ToArray();

    foreach (string company in companies)
    {
        Console.WriteLine(company);
    }
}

/*
 This code produces the following output:

 Coho Vineyard
 Lucerne Publishing
 Wingtip Toys
 Adventure Works
*/

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0
See Also

Reference

Tags :


Page view tracker