Enumerable.SkipWhile<TSource> Method (IEnumerable<TSource>, Func<TSource, Int32, Boolean>)
Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements. The element's index is used in the logic of the predicate function.
Assembly: System.Core (in System.Core.dll)
public static IEnumerable<TSource> SkipWhile<TSource>( this IEnumerable<TSource> source, Func<TSource, int, bool> predicate )
The type of the elements of source.
Return ValueType: System.Collections.Generic.IEnumerable<>
An IEnumerable<T> that contains the elements from the input sequence starting at the first element in the linear series that does not pass the test specified by predicate.
Usage NoteIn Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<>. 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).
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.
The method tests each element of source by using predicate and skips the element if the result is true. After the predicate function returns false for an element, that element and the remaining elements in source are yielded and there are no more invocations of predicate.
If predicate returns true for all elements in the sequence, an empty IEnumerable<T> is returned.
The first argument of predicate represents the element to test. The second argument represents the zero-based index of the element within source.
The TakeWhile and SkipWhile methods are functional complements. Given a sequence coll and a pure function p, concatenating the results of coll.TakeWhile(p) and coll.SkipWhile(p) yields the same sequence as coll.
In Visual Basic query expression syntax, a Skip While clause translates to an invocation of SkipWhile.
The following code example demonstrates how to use to skip elements of an array as long as a condition that depends on the element's index is true.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2