IExcelClient::Run method

Starts the calculation for the Excel workbook by using the partition, calculate, and merge model that Microsoft HPC Pack 2008 R2 Services for Excel 2010 uses to run calculations. The calculation runs on the HPC cluster with the head node that you specified when you called the IExcelClient::OpenSession method, unless you specify that the calculation should run on the local computer.

Syntax

HRESULT Run(
  [in] VARIANT_BOOL executeLocally,
  [in] Boolean      executeLocally
);
Function Run( _
  ByVal executeLocally As VARIANT_BOOL, _
  ByVal executeLocally As Boolean _
) As HRESULT

Parameters

  • executeLocally [in]

    C++

    Indicates whether to run the Excel workbook calculation on the local computer.

    VARIANT_TRUE indicates that the calculation should run on the local computer. VARIANT_FALSE indicates that the calculation should run on the HPC cluster with the head node that you specified when you called the IExcelClient::OpenSession method, and the calculation should run by using the partition, calculate, and merge model that Microsoft HPC Pack 2008 R2 Services for Excel 2010 uses to run calculations on an HPC cluster.

    VB

    Indicates whether to run the Excel workbook calculation on the local computer.

    True indicates that the calculation should run on the local computer. False indicates that the calculation should run on the HPC cluster with the head node that you specified when you called the IExcelClient::OpenSession method, and the calculation should run by using the partition, calculate, and merge model that Microsoft HPC Pack 2008 R2 Services for Excel 2010 uses to run calculations on an HPC cluster.

Return value

C++

Returns S_OK unless an exception occurs.

Remarks

You should call the IExcelClient::OpenSession method before you call the IExcelClient::Run method if you want to run the calculations in the workbook on an HPC cluster. You must call the IExcelClient::Initialize method before call the IExcelClient::Run method regardless of where you run the calculations in the workbook.

Requirements

Product

HPC Pack 2008 R2 Client Utilities

Type library

Microsoft.Hpc.Excel.tlb

See also

IExcelClient

IExcelClient::OpenSession

IExcelClient::Initialize