HpcLinqQueryable.LongTakeWhile Method

Article
04/22/2013

Gets the records in a set of records as long as a specified condition that depends on an index for the record that is an Int64 is true, then skips the remaining records.

Namespace: Microsoft.Hpc.Linq
Assembly: Microsoft.Hpc.Linq (in Microsoft.Hpc.Linq.dll)

Usage

'Usage
Dim source As IQueryable(Of TSource)
Dim predicate As Expression(Of Func(Of TSource, Long, Boolean))
Dim returnValue As IQueryable(Of TSource)

returnValue = HpcLinqQueryable.LongTakeWhile(source, predicate)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function LongTakeWhile(Of TSource) ( _
    source As IQueryable(Of TSource), _
    predicate As Expression(Of Func(Of TSource, Long, Boolean)) _
) As IQueryable(Of TSource)

[ExtensionAttribute] 
public static IQueryable<TSource> LongTakeWhile<TSource> (
    IQueryable<TSource> source,
    Expression<Func<TSource,long,bool>> predicate
)

[ExtensionAttribute] 
public:
generic<typename TSource>
static IQueryable<TSource>^ LongTakeWhile (
    IQueryable<TSource>^ source, 
    Expression<Func<TSource, long long, bool>^>^ predicate
)

J# supports the use of generic APIs, but not the declaration of new ones.

JScript does not support generic types or methods.

GenericParameters

TSource
The type of the records in the source parameter.

Parameters

source
A System.Linq.IQueryable<TSource> interface for the set of records that you want to process.

predicate
A System.Linq.Expressions.Expression(Func(TSource, Int64, Boolean)) object that specifies a function that tests whether each record and its index satisfy a condition. The second parameter of this function represents the index of the source element.

Return Value

An IQueryable interface that contains the results of the query.

Exceptions

Exception type	Condition
ArgumentNullException	The specified source or predicate parameter is a null reference (Nothing in Visual Basic).

Remarks

Use this method if you want to perform the same query as the TakeWhile method, but want to use an index that is an Int64 rather than an Int32 in the function that specifies the condition.

To get the records in a set of records as long as a specified condition that does not depend on an index for the record is true and then skip the remaining records , use the TakeWhile method.

Use the GetEnumerator method or the foreach statement of the C# language (For Each in Visual Basic) to get the results of the query. The enumerator contains records from the set of records specified in the source parameter that occur before the record at which the test specified by function provided in the predicate parameter no longer passes.

In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable<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).

This method has at least one parameter of type Expression with a type argument that is one of the Func types. For these parameters, you can pass in a lambda expression and it compiles to an Expression.

For more information about how the query runs and its behavior, see the Remarks section for the TakeWhile method.

Platform Note: This method was introduced in Windows HPC Server 2008 R2 with Service Pack 2 (SP2) and is not supported in previous versions.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012

Target Platforms

Windows XP, Windows Vista, Windows 7, Windows Server 2003, Windows Server 2003 R2, Windows Server 2008, Windows Server 2008 R2, with HPC Pack Client Utilities