Enumerable.Repeat(TResult) Method (System.Linq)

.NET Framework Class Library

Enumerable..::.Repeat<(Of <(TResult>)>) Method

Generates a sequence that contains one repeated value.

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

Syntax

Visual Basic (Declaration)

Public Shared Function Repeat(Of TResult) ( _
    element As TResult, _
    count As Integer _
) As IEnumerable(Of TResult)

Visual Basic (Usage)

Dim element As TResult
Dim count As Integer
Dim returnValue As IEnumerable(Of TResult)

returnValue = Enumerable.Repeat(element, _
    count)

public static IEnumerable<TResult> Repeat<TResult>(
    TResult element,
    int count
)

Visual C++

public:
generic<typename TResult>
static IEnumerable<TResult>^ Repeat(
    TResult element, 
    int count
)

JScript

JScript does not support generic types or methods.

Type Parameters

TResult: The type of the value to be repeated in the result sequence.

Parameters

element: Type: TResult
The value to be repeated.

count: Type: System..::.Int32
The number of times to repeat the value in the generated sequence.

Return Value

Type: System.Collections.Generic..::.IEnumerable<(Of <(TResult>)>)
An IEnumerable<(Of <(T>)>) that contains a repeated value.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	count is less than 0.

Remarks

This method is implemented by using deferred execution. The immediate return value is an object that stores all the information that is required to perform the action. The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.

Examples

The following code example demonstrates how to use Repeat<(Of <(TResult>)>) to generate a sequence of a repeated value.

Visual Basic

' Repeat the same string to create a sequence.
Dim sentences As IEnumerable(Of String) = _
    Enumerable.Repeat("I like programming.", 15)

Dim output As New System.Text.StringBuilder
For Each sentence As String In sentences
    output.AppendLine(sentence)
Next

' Display the output.
MsgBox(output.ToString())

' This code produces the following output:
'
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.
' I like programming.

IEnumerable<string> strings =
    Enumerable.Repeat("I like programming.", 15);

foreach (String str in strings)
{
    Console.WriteLine(str);
}

/*
 This code produces the following output:

 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
 I like programming.
*/

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

Reference

Enumerable Class

Enumerable Members

System.Linq Namespace