-
Notifications
You must be signed in to change notification settings - Fork 11
/
ExcelClient.xml
439 lines (439 loc) · 26.3 KB
/
ExcelClient.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
<Type Name="ExcelClient" FullName="Microsoft.Hpc.Excel.ExcelClient">
<TypeSignature Language="C#" Value="public class ExcelClient : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi ExcelClient extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Hpc.Excel.ExcelClient" />
<TypeSignature Language="VB.NET" Value="Public Class ExcelClient
Implements IDisposable" />
<TypeSignature Language="F#" Value="type ExcelClient = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents an engine that implements the partition, calculate, and merge model that Microsoft HPC Pack 2016 Services for Excel uses to run calculations in a workbook in parallel on an HPC cluster. The workbook must implement the callback macro framework.</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.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>Initializes a new instance of the <see cref="T:Microsoft.Hpc.Excel.ExcelClient" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BeginRun">
<MemberSignature Language="C#" Value="public IAsyncResult BeginRun (bool executeLocally, AsyncCallback userCallback, object userStateInfo);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginRun(bool executeLocally, class System.AsyncCallback userCallback, object userStateInfo) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.BeginRun(System.Boolean,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function BeginRun (executeLocally As Boolean, userCallback As AsyncCallback, userStateInfo As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="member this.BeginRun : bool * AsyncCallback * obj -> IAsyncResult" Usage="excelClient.BeginRun (executeLocally, userCallback, userStateInfo)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="executeLocally" Type="System.Boolean" />
<Parameter Name="userCallback" Type="System.AsyncCallback" />
<Parameter Name="userStateInfo" Type="System.Object" />
</Parameters>
<Docs>
<param name="executeLocally">To be added.</param>
<param name="userCallback">To be added.</param>
<param name="userStateInfo">To be added.</param>
<summary>Starts a calculation asynchronously for the Excel workbook using the partition, calculate, and merge model that Microsoft HPC Pack 2016 Services for Excel uses to run calculations. The calculation runs on the HPC cluster with the head node that you specified when you called the <see cref="Overload:Microsoft.Hpc.Excel.ExcelClient.OpenSession" /> method, unless you specify that the calculation should run on the local computer.</summary>
<returns>An <see cref="T:System.IAsyncResult"></see> interface to an object that contains information about the status of the asynchronous calculation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public void Cancel ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Cancel() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.Cancel" />
<MemberSignature Language="VB.NET" Value="Public Sub Cancel ()" />
<MemberSignature Language="F#" Value="member this.Cancel : unit -> unit" Usage="excelClient.Cancel " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Cancels any currently running Excel calculations without closing the SOA session.</summary>
<returns>None.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CloseSession">
<MemberSignature Language="C#" Value="public void CloseSession ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CloseSession() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.CloseSession" />
<MemberSignature Language="VB.NET" Value="Public Sub CloseSession ()" />
<MemberSignature Language="F#" Value="member this.CloseSession : unit -> unit" Usage="excelClient.CloseSession " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Closes the session that you opened by calling the <see cref="Overload:Microsoft.Hpc.Excel.ExcelClient.OpenSession" /> method subject to a default timeout period, and closes all instances of Excel that are running on the compute nodes.</summary>
<returns>None.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CloseSession">
<MemberSignature Language="C#" Value="public void CloseSession (int timeoutMilliseconds);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CloseSession(int32 timeoutMilliseconds) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.CloseSession(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub CloseSession (timeoutMilliseconds As Integer)" />
<MemberSignature Language="F#" Value="member this.CloseSession : int -> unit" Usage="excelClient.CloseSession timeoutMilliseconds" />
<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="timeoutMilliseconds" Type="System.Int32" />
</Parameters>
<Docs>
<param name="timeoutMilliseconds">To be added.</param>
<summary>Closes the session that you opened by calling the <see cref="Overload:Microsoft.Hpc.Excel.ExcelClient.OpenSession" /> method subject to the specified timeout period, and closes all instances of Excel that are running on the compute nodes.</summary>
<returns>None.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DependFiles">
<MemberSignature Language="C#" Value="public System.Collections.Generic.Dictionary<string,string> DependFiles { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.Dictionary`2<string, string> DependFiles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Excel.ExcelClient.DependFiles" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DependFiles As Dictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.DependFiles : System.Collections.Generic.Dictionary<string, string>" Usage="Microsoft.Hpc.Excel.ExcelClient.DependFiles" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.Dictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<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.ExcelClient.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="excelClient.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<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>Releases all of the resources that the object allocated.</summary>
<returns>None.</returns>
<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.ExcelClient.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> 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="Driver">
<MemberSignature Language="C#" Value="public Microsoft.Hpc.Excel.ExcelDriver Driver { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Hpc.Excel.ExcelDriver Driver" />
<MemberSignature Language="DocId" Value="P:Microsoft.Hpc.Excel.ExcelClient.Driver" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Driver As ExcelDriver" />
<MemberSignature Language="F#" Value="member this.Driver : Microsoft.Hpc.Excel.ExcelDriver" Usage="Microsoft.Hpc.Excel.ExcelClient.Driver" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Hpc.Excel.ExcelDriver</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:Microsoft.Hpc.Excel.ExcelDriver" /> object that interacts with the currently open Excel workbook.</summary>
<value>The <see cref="T:Microsoft.Hpc.Excel.ExcelDriver"></see> object that interacts with the currently open Excel workbook.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndRun">
<MemberSignature Language="C#" Value="public void EndRun (IAsyncResult asyncResult);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EndRun(class System.IAsyncResult asyncResult) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.EndRun(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Sub EndRun (asyncResult As IAsyncResult)" />
<MemberSignature Language="F#" Value="member this.EndRun : IAsyncResult -> unit" Usage="excelClient.EndRun asyncResult" />
<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="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="asyncResult">To be added.</param>
<summary>Ends a asynchronous calculation from an Excel workbook on an HPC cluster that you began by calling the <see cref="M:Microsoft.Hpc.Excel.ExcelClient.BeginRun(System.Boolean,System.AsyncCallback,System.Object)" /> method.</summary>
<returns>None.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorHandler">
<MemberSignature Language="C#" Value="public event EventHandler<Microsoft.Hpc.Excel.ResponseErrorEventArgs> ErrorHandler;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Hpc.Excel.ResponseErrorEventArgs> ErrorHandler" />
<MemberSignature Language="DocId" Value="E:Microsoft.Hpc.Excel.ExcelClient.ErrorHandler" />
<MemberSignature Language="VB.NET" Value="Public Event ErrorHandler As EventHandler(Of ResponseErrorEventArgs) " />
<MemberSignature Language="F#" Value="member this.ErrorHandler : EventHandler<Microsoft.Hpc.Excel.ResponseErrorEventArgs> " Usage="member this.ErrorHandler : System.EventHandler<Microsoft.Hpc.Excel.ResponseErrorEventArgs> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Hpc.Excel.ResponseErrorEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>An event that is raised when the response handler receives errors from the HPC cluster.</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 instance void Initialize(class Microsoft.Office.Interop.Excel.Workbook excelWorkbook) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.Initialize(Microsoft.Office.Interop.Excel.Workbook)" />
<MemberSignature Language="VB.NET" Value="Public Sub Initialize (excelWorkbook As Workbook)" />
<MemberSignature Language="F#" Value="member this.Initialize : Microsoft.Office.Interop.Excel.Workbook -> unit" Usage="excelClient.Initialize excelWorkbook" />
<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="excelWorkbook" Type="Microsoft.Office.Interop.Excel.Workbook" />
</Parameters>
<Docs>
<param name="excelWorkbook">To be added.</param>
<summary>Initializes the Excel SOA client by creating a new instance of the <see cref="T:Microsoft.Hpc.Excel.ExcelDriver" /> class to interact with the Excel workbook that is represented by the specified <see cref="T:Microsoft.Office.Interop.Excel.Workbook" /> object.</summary>
<returns>None.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public void Initialize (string localWorkbookPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Initialize(string localWorkbookPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.Initialize(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Initialize (localWorkbookPath As String)" />
<MemberSignature Language="F#" Value="member this.Initialize : string -> unit" Usage="excelClient.Initialize localWorkbookPath" />
<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="localWorkbookPath" Type="System.String" />
</Parameters>
<Docs>
<param name="localWorkbookPath">To be added.</param>
<summary>Initializes the Excel SOA client by creating a new instance of the <see cref="T:Microsoft.Hpc.Excel.ExcelDriver" /> class to interact with the Excel workbook located at the specified path.</summary>
<returns>None.</returns>
<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.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.ExcelClient.MacroResource" />
<MemberType>Property</MemberType>
<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 (Microsoft.Hpc.Scheduler.Session.SessionStartInfo startInfo, string remoteWorkbookPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 OpenSession(class Microsoft.Hpc.Scheduler.Session.SessionStartInfo startInfo, string remoteWorkbookPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.OpenSession(Microsoft.Hpc.Scheduler.Session.SessionStartInfo,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function OpenSession (startInfo As SessionStartInfo, remoteWorkbookPath As String) As Integer" />
<MemberSignature Language="F#" Value="member this.OpenSession : Microsoft.Hpc.Scheduler.Session.SessionStartInfo * string -> int" Usage="excelClient.OpenSession (startInfo, remoteWorkbookPath)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="startInfo" Type="Microsoft.Hpc.Scheduler.Session.SessionStartInfo" />
<Parameter Name="remoteWorkbookPath" Type="System.String" />
</Parameters>
<Docs>
<param name="startInfo">To be added.</param>
<param name="remoteWorkbookPath">To be added.</param>
<summary>Starts a new SOA session using the settings in the specified <see cref="T:Microsoft.Hpc.Scheduler.Session.SessionStartInfo" /> object to perform calculations from the specified Excel workbook on an HPC cluster.</summary>
<returns>An <see cref="T:System.Int32"></see> that specifies the identifier of the SOA session that the method created.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OpenSession">
<MemberSignature Language="C#" Value="public int OpenSession (string headNode, int minResources, int maxResources, Microsoft.Hpc.Scheduler.Session.SessionUnitType resourceType, string remoteWorkbookPath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 OpenSession(string headNode, int32 minResources, int32 maxResources, valuetype Microsoft.Hpc.Scheduler.Session.SessionUnitType resourceType, string remoteWorkbookPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.OpenSession(System.String,System.Int32,System.Int32,Microsoft.Hpc.Scheduler.Session.SessionUnitType,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function OpenSession (headNode As String, minResources As Integer, maxResources As Integer, resourceType As SessionUnitType, remoteWorkbookPath As String) As Integer" />
<MemberSignature Language="F#" Value="member this.OpenSession : string * int * int * Microsoft.Hpc.Scheduler.Session.SessionUnitType * string -> int" Usage="excelClient.OpenSession (headNode, minResources, maxResources, resourceType, remoteWorkbookPath)" />
<MemberType>Method</MemberType>
<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="minResources" Type="System.Int32" />
<Parameter Name="maxResources" Type="System.Int32" />
<Parameter Name="resourceType" Type="Microsoft.Hpc.Scheduler.Session.SessionUnitType" />
<Parameter Name="remoteWorkbookPath" Type="System.String" />
</Parameters>
<Docs>
<param name="headNode">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="remoteWorkbookPath">To be added.</param>
<summary>Starts a new SOA session using the specified resource settings to perform calculations from the specified Excel workbook on the HPC cluster with the specified head node.</summary>
<returns>An <see cref="T:System.Int32"></see> that specifies the identifier of the SOA session that the method created.</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 instance void Run(bool executeLocally) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Hpc.Excel.ExcelClient.Run(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub Run (executeLocally As Boolean)" />
<MemberSignature Language="F#" Value="member this.Run : bool -> unit" Usage="excelClient.Run executeLocally" />
<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="executeLocally" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="executeLocally">To be added.</param>
<summary>Starts the calculation for the Excel workbook using the partition, calculate, and merge model that Microsoft HPC Pack 2016 Services for Excel uses to run calculations. The calculation runs on the HPC cluster with the head node that you specified when you called the <see cref="Overload:Microsoft.Hpc.Excel.ExcelClient.OpenSession" /> method, unless you specify that the calculation should run on the local computer.</summary>
<returns>None.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public static readonly Version Version;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Version Version" />
<MemberSignature Language="DocId" Value="F:Microsoft.Hpc.Excel.ExcelClient.Version" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Version As Version " />
<MemberSignature Language="F#" Value=" staticval mutable Version : Version" Usage="Microsoft.Hpc.Excel.ExcelClient.Version" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Hpc.Excel</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Version</ReturnType>
</ReturnValue>
<Docs>
<summary>Represents the version of the Excel client.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>