HpcLinqQueryable.SubmitAndWait Method

Article
04/22/2013

Submits a LINQ to HPC query to an HPC cluster so that the query can run on records from a DSC file set, and does not return until the job that runs the query completes.

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

Usage

'Usage
Dim source As IQueryable(Of TSource)
Dim returnValue As HpcLinqJobInfo

returnValue = HpcLinqQueryable.SubmitAndWait(source)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function SubmitAndWait(Of TSource) ( _
    source As IQueryable(Of TSource) _
) As HpcLinqJobInfo

[ExtensionAttribute] 
public static HpcLinqJobInfo SubmitAndWait<TSource> (
    IQueryable<TSource> source
)

[ExtensionAttribute] 
public:
generic<typename TSource>
static HpcLinqJobInfo^ SubmitAndWait (
    IQueryable<TSource>^ source
)

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 query that you want to run.

Return Value

A HpcLinqJobInfo that contains information about the job that is created to run the query on the HPC cluster.

Exceptions

Exception type	Condition
ArgumentNullException	The specified source parameter is a null reference (Nothing in Visual Basic).
HpcLinqException	The job that the HPC Job Scheduler Service created to run the query failed or was cancelled, or repeated errors occurred when checking the status of that job.

Remarks

The SubmitAndWait method blocks the thread from running until the job that runs the query completes. To submit the query and block the thread only until the HPC Job Scheduler Service creates the job that runs the query, use the Submit method instead.

Use the GetEnumerator method or the foreach statement of the C# language (For Each in Visual Basic) to get the results of the query.

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).

Platform Note: This method was introduced in Windows HPC Server 2008 R2 with Service Pack 3 (SP3).

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