Cluster.WaitForCommandWithPaging Method

Article
04/17/2009

Waits for execution of the specified command to be completed on at least one node. The output is returned in the requested page size.

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

Usage

Syntax

'Declaration
Public Function WaitForCommandWithPaging ( _
    id As Integer, _
    pageSize As Integer _
) As IClusterEnumerable

public IClusterEnumerable WaitForCommandWithPaging (
    int id,
    int pageSize
)

public:
virtual IClusterEnumerable^ WaitForCommandWithPaging (
    int id, 
    int pageSize
) sealed

public final IClusterEnumerable WaitForCommandWithPaging (
    int id, 
    int pageSize
)

public final function WaitForCommandWithPaging (
    id : int, 
    pageSize : int
) : IClusterEnumerable

Parameters

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

pageSize
The number of Unicode characters to return in each page of the output. The minimum size is 2,048 Unicode characters, and the maximum size is 20,480. If the value is outside this range, the method determines the page size.

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 the Cluster.ExecuteCommandWithPaging method 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 Cluster.ReadExecutionResult method in a loop until the output string is empty.

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