Share via


ICluster::put_IsAsynchronous method

Sets whether calls to the server are executed asynchronously.

Syntax

HRESULT put_IsAsynchronous(
  [in] VARIANT_BOOL Val
);

Parameters

  • Val [in]
    Specify VARIANT_TRUE to execute calls on the cluster asynchronously. Specify VARIANT_FALSE to execute calls synchronously (the default).

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code. To get a description of the error, call the ICluster::get_ErrorMessage method.

Remarks

By default, calls to the cluster are executed synchronously. The default behavior is the best choice for most applications. If enabled, calls return immediately. The caller must query the status of the node, job, or task to determine whether the operation succeeded or failed. The rate at which you poll is application dependent.

The following methods of the ICluster interface can execute asynchronously:

Note that QueueJob and SubmitJob are non-blocking operations.

To check the current setting, call the ICluster::get_IsAsynchronous method.

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

Ccpapi.tlb

See also

ICluster

ICluster::get_IsAsynchronous