Cluster.WaitForCommand Method

Article
04/17/2009

Waits for execution of the command to be completed on at least one node.

Namespace: Microsoft.ComputeCluster
Assembly: CcpAPI (in ccpapi.dll)

Usage

Syntax

'Declaration
Public Function WaitForCommand ( _
    id As Integer _
) As IClusterEnumerable

public IClusterEnumerable WaitForCommand (
    int id
)

public:
virtual IClusterEnumerable^ WaitForCommand (
    int id
) sealed

public final IClusterEnumerable WaitForCommand (
    int id
)

public final function WaitForCommand (
    id : int
) : IClusterEnumerable

Parameters

id
The command identifier. This is the same identifier passed to the Cluster.ExecuteCommand method.

Return Value

An IClusterEnumerable interface that contains the collection of IExecutionResult interfaces. The enumerable object is empty when there are no commands left to return.

Remarks

Call this method only if you set the Cluster.IsAsynchronous property to true and called ExecuteCommand to execute the command.

To retrieve all results, call this method in a loop until all results are retrieved (the enumerable object is empty).

To get the output for each result, call the IExecutionResult.Output method.

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

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003, Windows XP

Target Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003 with Compute Cluster Pack Client Utilities, Windows XP with Compute Cluster Pack Client Utilities