Repository navigation
Expand file tree
/
Copy pathAddInProcess.xml
More file actions
382 lines (353 loc) · 22.1 KB
/
Copy pathAddInProcess.xml
File metadata and controls
382 lines (353 loc) · 22.1 KB
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
<Type Name="AddInProcess" FullName="System.AddIn.Hosting.AddInProcess">
<TypeSignature Language="C#" Value="public sealed class AddInProcess" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AddInProcess extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.AddIn.Hosting.AddInProcess" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class AddInProcess" />
<TypeSignature Language="C++ CLI" Value="public ref class AddInProcess sealed" />
<TypeSignature Language="F#" Value="type AddInProcess = class" />
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides an external process for running add-ins out-of-process from the host application.</summary>
<remarks>
<format type="text/markdown"><]
[!code-vb[AddInP3Host#10](~/samples/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb#10)]
]]></format>
</remarks>
<related type="Article" href="http://msdn.microsoft.com/library/8dd45b02-7218-40f9-857d-40d7b98b850b">Add-Ins and Extensibility</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.AddIn.Hosting.AddInProcess" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AddInProcess ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInProcess.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 AddInProcess();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.AddIn.Hosting.AddInProcess" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor has the same effect as using the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor with the <xref:System.AddIn.Hosting.Platform.Host?displayProperty=nameWithType> flag, to specify that the process that runs the add-in will have the same bits-per-word as the host process.
]]></format>
</remarks>
<permission cref="F:System.Security.Permissions.SecurityAction.Demand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AddInProcess (System.AddIn.Hosting.Platform platform);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.AddIn.Hosting.Platform platform) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInProcess.#ctor(System.AddIn.Hosting.Platform)" />
<MemberSignature Language="C++ CLI" Value="public:
 AddInProcess(System::AddIn::Hosting::Platform platform);" />
<MemberSignature Language="F#" Value="new System.AddIn.Hosting.AddInProcess : System.AddIn.Hosting.Platform -> System.AddIn.Hosting.AddInProcess" Usage="new System.AddIn.Hosting.AddInProcess platform" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="platform" Type="System.AddIn.Hosting.Platform" />
</Parameters>
<Docs>
<param name="platform">A value that specifies the bits-per-word of the process that runs the add-in.</param>
<summary>Initializes a new instance of the <see cref="T:System.AddIn.Hosting.AddInProcess" /> class, specifying the bits-per-word of the process in which the add-in runs.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows how `platform` affects the bits-per-word of the process on different operating systems:
||32-bit operating system|64-bit operating system|
|-|------------------------------|------------------------------|
|Host|32-bit|Same as the host process|
|AnyCPU|32-bit|64-bit|
|X86|32-bit|32-bit|
|X64|Exception is thrown|64-bit|
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The registry entry for the path to the executable (AddInProcess.exe or AddInProcess32.exe) is missing.
-or-
The executable is missing.</exception>
<permission cref="F:System.Security.Permissions.SecurityAction.Demand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
</Docs>
</Member>
<Member MemberName="IsCurrentProcess">
<MemberSignature Language="C#" Value="public bool IsCurrentProcess { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsCurrentProcess" />
<MemberSignature Language="DocId" Value="P:System.AddIn.Hosting.AddInProcess.IsCurrentProcess" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsCurrentProcess As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsCurrentProcess { bool get(); };" />
<MemberSignature Language="F#" Value="member this.IsCurrentProcess : bool" Usage="System.AddIn.Hosting.AddInProcess.IsCurrentProcess" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether the current <see cref="T:System.AddIn.Hosting.AddInProcess" /> object represents the host application process.</summary>
<value>
<see langword="true" /> if the <see cref="T:System.AddIn.Hosting.AddInProcess" /> object corresponds to the current process; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the value of this property is `true`, the add-in is running in-process with the host application. In that case, using the <xref:System.AddIn.Hosting.AddInProcess.Start%2A> or <xref:System.AddIn.Hosting.AddInProcess.Shutdown%2A> method throws an <xref:System.InvalidOperationException>.
> [!NOTE]
> The <xref:System.AddIn.Hosting.AddInEnvironment.Process%2A?displayProperty=nameWithType> property returns an <xref:System.AddIn.Hosting.AddInProcess> object that represents the host application process if the add-in is running in-process.
## Examples
The following example activates an add-in in an external process and uses the <xref:System.AddIn.Hosting.AddInProcess.IsCurrentProcess%2A> property to determine whether the add-in is in the same process as the host application process.
[!code-csharp[AddInP3Host#10](~/samples/snippets/csharp/VS_Snippets_CLR/addinP3Host/cs/P3Host.cs#10)]
[!code-vb[AddInP3Host#10](~/samples/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb#10)]
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="KeepAlive">
<MemberSignature Language="C#" Value="public bool KeepAlive { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool KeepAlive" />
<MemberSignature Language="DocId" Value="P:System.AddIn.Hosting.AddInProcess.KeepAlive" />
<MemberSignature Language="VB.NET" Value="Public Property KeepAlive As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool KeepAlive { bool get(); void set(bool value); };" />
<MemberSignature Language="F#" Value="member this.KeepAlive : bool with get, set" Usage="System.AddIn.Hosting.AddInProcess.KeepAlive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether to keep the external process alive.</summary>
<value>
<see langword="true" /> if the external process should be kept alive; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Set this property to `false` to aggressively shut down the external process after the last add-in inside the process has been shut down.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Platform">
<MemberSignature Language="C#" Value="public System.AddIn.Hosting.Platform Platform { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.AddIn.Hosting.Platform Platform" />
<MemberSignature Language="DocId" Value="P:System.AddIn.Hosting.AddInProcess.Platform" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Platform As Platform" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::AddIn::Hosting::Platform Platform { System::AddIn::Hosting::Platform get(); };" />
<MemberSignature Language="F#" Value="member this.Platform : System.AddIn.Hosting.Platform" Usage="System.AddIn.Hosting.AddInProcess.Platform" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.AddIn.Hosting.Platform</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the bits-per-word of the process in which the out-of-process add-in is run.</summary>
<value>The bits-per-word of the process that runs the add-in.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The bits-per-word is set when the <xref:System.AddIn.Hosting.AddInProcess> object is initialized, and cannot be changed.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ProcessId">
<MemberSignature Language="C#" Value="public int ProcessId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ProcessId" />
<MemberSignature Language="DocId" Value="P:System.AddIn.Hosting.AddInProcess.ProcessId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ProcessId As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int ProcessId { int get(); };" />
<MemberSignature Language="F#" Value="member this.ProcessId : int" Usage="System.AddIn.Hosting.AddInProcess.ProcessId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the process ID of the external process.</summary>
<value>The process ID, or -1 if the external process has not started.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this property for debugging.
]]></format>
</remarks>
<permission cref="F:System.Security.Permissions.SecurityAction.LinkDemand">for full trust for the immediate caller. This member cannot be used by partially trusted code.</permission>
</Docs>
</Member>
<Member MemberName="Shutdown">
<MemberSignature Language="C#" Value="public bool Shutdown ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Shutdown() cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInProcess.Shutdown" />
<MemberSignature Language="VB.NET" Value="Public Function Shutdown () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 bool Shutdown();" />
<MemberSignature Language="F#" Value="member this.Shutdown : unit -> bool" Usage="addInProcess.Shutdown " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Forcibly shuts down the external process.</summary>
<returns>
<see langword="true" /> if the external process was running and is successfully shut down; <see langword="false" /> if there is no active process associated with the <see cref="T:System.AddIn.Hosting.AddInProcess" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The add-in is running in-process with the host application. Starting and stopping the process is allowed only for external processes, not for the host process.</exception>
</Docs>
</Member>
<Member MemberName="ShuttingDown">
<MemberSignature Language="C#" Value="public event EventHandler<System.ComponentModel.CancelEventArgs> ShuttingDown;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class System.ComponentModel.CancelEventArgs> ShuttingDown" />
<MemberSignature Language="DocId" Value="E:System.AddIn.Hosting.AddInProcess.ShuttingDown" />
<MemberSignature Language="VB.NET" Value="Public Event ShuttingDown As EventHandler(Of CancelEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler<System::ComponentModel::CancelEventArgs ^> ^ ShuttingDown;" />
<MemberSignature Language="F#" Value="member this.ShuttingDown : EventHandler<System.ComponentModel.CancelEventArgs> " Usage="member this.ShuttingDown : System.EventHandler<System.ComponentModel.CancelEventArgs> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<System.ComponentModel.CancelEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>Occurs when the process represented by the <see cref="T:System.AddIn.Hosting.AddInProcess" /> object is about to be shut down.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public bool Start ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Start() cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInProcess.Start" />
<MemberSignature Language="VB.NET" Value="Public Function Start () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 bool Start();" />
<MemberSignature Language="F#" Value="member this.Start : unit -> bool" Usage="addInProcess.Start " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Starts the external process.</summary>
<returns>
<see langword="true" /> if the process is successfully started; <see langword="false" /> if the process is already running.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The add-in is running in-process with the host application. Starting and stopping the process is allowed only for external processes, not for the host process.</exception>
</Docs>
</Member>
<Member MemberName="StartupTimeout">
<MemberSignature Language="C#" Value="public TimeSpan StartupTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan StartupTimeout" />
<MemberSignature Language="DocId" Value="P:System.AddIn.Hosting.AddInProcess.StartupTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property StartupTimeout As TimeSpan" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan StartupTimeout { TimeSpan get(); void set(TimeSpan value); };" />
<MemberSignature Language="F#" Value="member this.StartupTimeout : TimeSpan with get, set" Usage="System.AddIn.Hosting.AddInProcess.StartupTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the number of seconds to allow for the process to start.</summary>
<value>The number of seconds to allow for process startup.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value is 10 seconds. This property is usually used during debugging, to increase the startup time for the process that runs the out-of-process add-in.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">The process is already running.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The assigned value is less than 0 (zero).</exception>
</Docs>
</Member>
</Members>
</Type>