ExcelClient.xml

<Type Name="ExcelClient" FullName="Microsoft.Hpc.Excel.Com.ExcelClient">
  <TypeSignature Language="C#" Value="public class ExcelClient : IDisposable, Microsoft.Hpc.Excel.Com.IExcelClient, Microsoft.Hpc.Excel.Com.IExcelClientV1" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ExcelClient extends System.Object implements class Microsoft.Hpc.Excel.Com.IExcelClient, class Microsoft.Hpc.Excel.Com.IExcelClientV1, class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Hpc.Excel.Com.ExcelClient" />
  <TypeSignature Language="VB.NET" Value="Public Class ExcelClient&#xA;Implements IDisposable, IExcelClient, IExcelClientV1" />
  <TypeSignature Language="F#" Value="type ExcelClient = class&#xA;    interface IExcelClient&#xA;    interface IExcelClientV1&#xA;    interface IDisposable" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>Microsoft.Hpc.Excel.Com.IExcelClient</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>Microsoft.Hpc.Excel.Com.IExcelClientV1</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.Guid("9A716A75-166F-4EFF-B5B5-5E8CDBEFB375")</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.ProgId("Microsoft.Hpc.Excel.ExcelClient")</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Provides the functionality of the <see cref="T:Microsoft.Hpc.Excel.ExcelClient" /> class over the Component Object Model (COM).</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ExcelClient ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Cancel">
      <MemberSignature Language="C#" Value="public void Cancel ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Cancel() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.Cancel" />
      <MemberSignature Language="VB.NET" Value="Public Sub Cancel ()" />
      <MemberSignature Language="F#" Value="abstract member Cancel : unit -&gt; unit&#xA;override this.Cancel : unit -&gt; unit" Usage="excelClient.Cancel " />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClient.Cancel</InterfaceMember>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClientV1.Cancel</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CloseSession">
      <MemberSignature Language="C#" Value="public void CloseSession (object timeoutMilliseconds);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void CloseSession(object timeoutMilliseconds) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.CloseSession(System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Sub CloseSession (Optional timeoutMilliseconds As Object)" />
      <MemberSignature Language="F#" Value="abstract member CloseSession : obj -&gt; unit&#xA;override this.CloseSession : obj -&gt; unit" Usage="excelClient.CloseSession timeoutMilliseconds" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClient.CloseSession(System.Object)</InterfaceMember>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClientV1.CloseSession(System.Object)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="timeoutMilliseconds" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="timeoutMilliseconds">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.Dispose" />
      <MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="excelClient.Dispose " />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClient.Dispose</InterfaceMember>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClientV1.Dispose</InterfaceMember>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.Dispose(System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
      <MemberSignature Language="F#" Value="abstract member Dispose : bool -&gt; unit&#xA;override this.Dispose : bool -&gt; unit" Usage="excelClient.Dispose disposing" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="disposing">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Initialize">
      <MemberSignature Language="C#" Value="public void Initialize (Microsoft.Office.Interop.Excel.Workbook excelWorkbook);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Initialize(class Microsoft.Office.Interop.Excel.Workbook excelWorkbook) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.Initialize(Microsoft.Office.Interop.Excel.Workbook)" />
      <MemberSignature Language="VB.NET" Value="Public Sub Initialize (excelWorkbook As Workbook)" />
      <MemberSignature Language="F#" Value="abstract member Initialize : Microsoft.Office.Interop.Excel.Workbook -&gt; unit&#xA;override this.Initialize : Microsoft.Office.Interop.Excel.Workbook -&gt; unit" Usage="excelClient.Initialize excelWorkbook" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClientV1.Initialize(Microsoft.Office.Interop.Excel.Workbook)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="excelWorkbook" Type="Microsoft.Office.Interop.Excel.Workbook" />
      </Parameters>
      <Docs>
        <param name="excelWorkbook">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Initialize">
      <MemberSignature Language="C#" Value="public void Initialize (Microsoft.Office.Interop.Excel.Workbook excelWorkbook, string dependFiles);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Initialize(class Microsoft.Office.Interop.Excel.Workbook excelWorkbook, string dependFiles) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.Initialize(Microsoft.Office.Interop.Excel.Workbook,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub Initialize (excelWorkbook As Workbook, Optional dependFiles As String)" />
      <MemberSignature Language="F#" Value="abstract member Initialize : Microsoft.Office.Interop.Excel.Workbook * string -&gt; unit&#xA;override this.Initialize : Microsoft.Office.Interop.Excel.Workbook * string -&gt; unit" Usage="excelClient.Initialize (excelWorkbook, dependFiles)" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClient.Initialize(Microsoft.Office.Interop.Excel.Workbook,System.String)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="excelWorkbook" Type="Microsoft.Office.Interop.Excel.Workbook" />
        <Parameter Name="dependFiles" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="excelWorkbook">To be added.</param>
        <param name="dependFiles">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MacroResource">
      <MemberSignature Language="C#" Value="public string MacroResource { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string MacroResource" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Excel.Com.ExcelClient.MacroResource" />
      <MemberSignature Language="VB.NET" Value="Public Property MacroResource As String" />
      <MemberSignature Language="F#" Value="member this.MacroResource : string with get, set" Usage="Microsoft.Hpc.Excel.Com.ExcelClient.MacroResource" />
      <MemberType>Property</MemberType>
      <Implements>
        <InterfaceMember>P:Microsoft.Hpc.Excel.Com.IExcelClient.MacroResource</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OpenSession">
      <MemberSignature Language="C#" Value="public int OpenSession (string headNode, string remoteWorkbookPath, object minResources, object maxResources, object resourceType, string jobTemplate, string serviceName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 OpenSession(string headNode, string remoteWorkbookPath, object minResources, object maxResources, object resourceType, string jobTemplate, string serviceName) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.OpenSession(System.String,System.String,System.Object,System.Object,System.Object,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function OpenSession (headNode As String, remoteWorkbookPath As String, Optional minResources As Object, Optional maxResources As Object, Optional resourceType As Object, Optional jobTemplate As String, Optional serviceName As String) As Integer" />
      <MemberSignature Language="F#" Value="abstract member OpenSession : string * string * obj * obj * obj * string * string -&gt; int&#xA;override this.OpenSession : string * string * obj * obj * obj * string * string -&gt; int" Usage="excelClient.OpenSession (headNode, remoteWorkbookPath, minResources, maxResources, resourceType, jobTemplate, serviceName)" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClientV1.OpenSession(System.String,System.String,System.Object,System.Object,System.Object,System.String,System.String)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="headNode" Type="System.String" />
        <Parameter Name="remoteWorkbookPath" Type="System.String" />
        <Parameter Name="minResources" Type="System.Object" />
        <Parameter Name="maxResources" Type="System.Object" />
        <Parameter Name="resourceType" Type="System.Object" />
        <Parameter Name="jobTemplate" Type="System.String" />
        <Parameter Name="serviceName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="headNode">To be added.</param>
        <param name="remoteWorkbookPath">To be added.</param>
        <param name="minResources">To be added.</param>
        <param name="maxResources">To be added.</param>
        <param name="resourceType">To be added.</param>
        <param name="jobTemplate">To be added.</param>
        <param name="serviceName">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OpenSession">
      <MemberSignature Language="C#" Value="public int OpenSession (string headNode, string remoteWorkbookPath, object minResources, object maxResources, object resourceType, string jobTemplate, string serviceName, string jobName, string projectName, string transportScheme, object useAzureQueue, string username, string password, object jobPriority);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 OpenSession(string headNode, string remoteWorkbookPath, object minResources, object maxResources, object resourceType, string jobTemplate, string serviceName, string jobName, string projectName, string transportScheme, object useAzureQueue, string username, string password, object jobPriority) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.OpenSession(System.String,System.String,System.Object,System.Object,System.Object,System.String,System.String,System.String,System.String,System.String,System.Object,System.String,System.String,System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Function OpenSession (headNode As String, remoteWorkbookPath As String, Optional minResources As Object, Optional maxResources As Object, Optional resourceType As Object, Optional jobTemplate As String, Optional serviceName As String, Optional jobName As String, Optional projectName As String, Optional transportScheme As String, Optional useAzureQueue As Object, Optional username As String, Optional password As String, Optional jobPriority As Object) As Integer" />
      <MemberSignature Language="F#" Value="abstract member OpenSession : string * string * obj * obj * obj * string * string * string * string * string * obj * string * string * obj -&gt; int&#xA;override this.OpenSession : string * string * obj * obj * obj * string * string * string * string * string * obj * string * string * obj -&gt; int" Usage="excelClient.OpenSession (headNode, remoteWorkbookPath, minResources, maxResources, resourceType, jobTemplate, serviceName, jobName, projectName, transportScheme, useAzureQueue, username, password, jobPriority)" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClient.OpenSession(System.String,System.String,System.Object,System.Object,System.Object,System.String,System.String,System.String,System.String,System.String,System.Object,System.String,System.String,System.Object)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="headNode" Type="System.String" />
        <Parameter Name="remoteWorkbookPath" Type="System.String" />
        <Parameter Name="minResources" Type="System.Object" />
        <Parameter Name="maxResources" Type="System.Object" />
        <Parameter Name="resourceType" Type="System.Object" />
        <Parameter Name="jobTemplate" Type="System.String" />
        <Parameter Name="serviceName" Type="System.String" />
        <Parameter Name="jobName" Type="System.String" />
        <Parameter Name="projectName" Type="System.String" />
        <Parameter Name="transportScheme" Type="System.String" />
        <Parameter Name="useAzureQueue" Type="System.Object" />
        <Parameter Name="username" Type="System.String" />
        <Parameter Name="password" Type="System.String" />
        <Parameter Name="jobPriority" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="headNode">To be added.</param>
        <param name="remoteWorkbookPath">To be added.</param>
        <param name="minResources">To be added.</param>
        <param name="maxResources">To be added.</param>
        <param name="resourceType">To be added.</param>
        <param name="jobTemplate">To be added.</param>
        <param name="serviceName">To be added.</param>
        <param name="jobName">To be added.</param>
        <param name="projectName">To be added.</param>
        <param name="transportScheme">To be added.</param>
        <param name="useAzureQueue">To be added.</param>
        <param name="username">To be added.</param>
        <param name="password">To be added.</param>
        <param name="jobPriority">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Run">
      <MemberSignature Language="C#" Value="public void Run (bool executeLocally);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Run(bool executeLocally) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.Com.ExcelClient.Run(System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Public Sub Run (executeLocally As Boolean)" />
      <MemberSignature Language="F#" Value="abstract member Run : bool -&gt; unit&#xA;override this.Run : bool -&gt; unit" Usage="excelClient.Run executeLocally" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClient.Run(System.Boolean)</InterfaceMember>
        <InterfaceMember>M:Microsoft.Hpc.Excel.Com.IExcelClientV1.Run(System.Boolean)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="executeLocally" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="executeLocally">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Version">
      <MemberSignature Language="C#" Value="public string Version { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Version" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Excel.Com.ExcelClient.Version" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Version As String" />
      <MemberSignature Language="F#" Value="member this.Version : string" Usage="Microsoft.Hpc.Excel.Com.ExcelClient.Version" />
      <MemberType>Property</MemberType>
      <Implements>
        <InterfaceMember>P:Microsoft.Hpc.Excel.Com.IExcelClient.Version</InterfaceMember>
        <InterfaceMember>P:Microsoft.Hpc.Excel.Com.IExcelClientV1.Version</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>