/
AddInStore.xml
616 lines (563 loc) · 42.8 KB
/
AddInStore.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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
<Type Name="AddInStore" FullName="System.AddIn.Hosting.AddInStore">
<TypeSignature Language="C#" Value="public static class AddInStore" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit AddInStore extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.AddIn.Hosting.AddInStore" />
<TypeSignature Language="VB.NET" Value="Public Class AddInStore" />
<TypeSignature Language="F#" Value="type AddInStore = class" />
<TypeSignature Language="C++ CLI" Value="public ref class AddInStore abstract sealed" />
<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 methods to store and find information about available add-ins and pipeline segments.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this class to build, rebuild, and update two cache files, as described in the following table.
|Cache file|Methods that create the file|
|----------------|----------------------------------|
|PipelineSegments.store<br /><br /> This file is located in the root directory of the pipeline directory structure.|<xref:System.AddIn.Hosting.AddInStore.Update%2A><br /><br /> Updates the file with new pipeline segments. If no new segments are installed, this method just validates the cache.<br /><br /> <xref:System.AddIn.Hosting.AddInStore.Rebuild%2A><br /><br /> Rebuilds the file and includes new pipeline segments.|
|AddIns.store<br /><br /> This file is located in a directory that contains one or more add-in subdirectories. If this directory is in the pipeline directory structure, it must be named AddIns.|<xref:System.AddIn.Hosting.AddInStore.UpdateAddIns%2A><br /><br /> Updates the file with new add-ins at a specified location. Call this method if your add-ins are outside the pipeline directory structure.<br /><br /> If no new add-ins are installed, this method just validates the cache.<br /><br /> <xref:System.AddIn.Hosting.AddInStore.RebuildAddIns%2A><br /><br /> Rebuilds the file and includes add-ins at a specified location. Call this method if your add-ins are outside the pipeline directory structure.<br /><br /> <xref:System.AddIn.Hosting.AddInStore.Update%2A><br /><br /> If the add-ins are in the pipeline directory structure, this method updates the file with new add-ins.<br /><br /> <xref:System.AddIn.Hosting.AddInStore.Rebuild%2A><br /><br /> If the add-ins are in the pipeline directory structure, this method rebuilds the file and includes new add-ins.|
These methods create the cache files if they do not previously exist.
After the cache files are created, use the <xref:System.AddIn.Hosting.AddInStore.FindAddIns%2A> method to examine the files to find all add-ins that match a specified host view of the add-in. You can also use the <xref:System.AddIn.Hosting.AddInStore.FindAddIn%2A> method to find a specific add-in.
> [!IMPORTANT]
> It is unsupported to allow untrusted users or entities to access PipelineSegments.store and Addins.store. Doing so can cause data corruption issues for applications.
## Examples
The following example shows how to update cache files.
:::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet2":::
]]></format>
</remarks>
<related type="Article" href="/previous-versions/dotnet/netframework-4.0/bb384200(v=vs.100)">Add-Ins and Extensibility</related>
</Docs>
<Members>
<Member MemberName="FindAddIn">
<MemberSignature Language="C#" Value="public static System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken> FindAddIn (Type hostViewOfAddIn, string pipelineRootFolderPath, string addInFilePath, string addInTypeName);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.ObjectModel.Collection`1<class System.AddIn.Hosting.AddInToken> FindAddIn(class System.Type hostViewOfAddIn, string pipelineRootFolderPath, string addInFilePath, string addInTypeName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.FindAddIn(System.Type,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FindAddIn (hostViewOfAddIn As Type, pipelineRootFolderPath As String, addInFilePath As String, addInTypeName As String) As Collection(Of AddInToken)" />
<MemberSignature Language="F#" Value="static member FindAddIn : Type * string * string * string -> System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken>" Usage="System.AddIn.Hosting.AddInStore.FindAddIn (hostViewOfAddIn, pipelineRootFolderPath, addInFilePath, addInTypeName)" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Collections::ObjectModel::Collection<System::AddIn::Hosting::AddInToken ^> ^ FindAddIn(Type ^ hostViewOfAddIn, System::String ^ pipelineRootFolderPath, System::String ^ addInFilePath, System::String ^ addInTypeName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostViewOfAddIn" Type="System.Type" />
<Parameter Name="pipelineRootFolderPath" Type="System.String" />
<Parameter Name="addInFilePath" Type="System.String" />
<Parameter Name="addInTypeName" Type="System.String" />
</Parameters>
<Docs>
<param name="hostViewOfAddIn">The type that defines the host's view of the add-in.</param>
<param name="pipelineRootFolderPath">The path to the root of the pipeline directory structure.</param>
<param name="addInFilePath">The path and file name of the add-in to find.</param>
<param name="addInTypeName">The type name of the add-in.</param>
<summary>Finds a specific add-in.</summary>
<returns>A collection of tokens that contains only the token representing the add-in that was found.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If a single pipeline for an add-in is found, it will be the only item in the <xref:System.AddIn.Hosting.AddInToken> collection. If multiple pipelines to the specified add-in are found, you can differentiate them by examining the <xref:System.AddIn.Hosting.AddInToken.QualificationData%2A> property.
## Examples
The following example finds a specific add-in.
:::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet6":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet6":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The length of <paramref name="pipelineRootFolderPath" /> or <paramref name="addInFilePath" /> or <paramref name="addInTypeName" /> is 0.
-or-
The add-in file does not exist in <paramref name="addInfilePath" />.</exception>
<exception cref="T:System.ArgumentNullException">One or more parameters are <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The caller does not have read access permission to <paramref name="pipelineRootFolderPath" />.</exception>
<altmember cref="M:System.AddIn.Hosting.AddInStore.FindAddIns(System.Type,System.String,System.String[])" />
</Docs>
</Member>
<MemberGroup MemberName="FindAddIns">
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Finds all add-ins for a specified host view of the add-in.</summary>
</Docs>
</MemberGroup>
<Member MemberName="FindAddIns">
<MemberSignature Language="C#" Value="public static System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken> FindAddIns (Type hostViewOfAddIn, System.AddIn.Hosting.PipelineStoreLocation location);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.ObjectModel.Collection`1<class System.AddIn.Hosting.AddInToken> FindAddIns(class System.Type hostViewOfAddIn, valuetype System.AddIn.Hosting.PipelineStoreLocation location) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.FindAddIns(System.Type,System.AddIn.Hosting.PipelineStoreLocation)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FindAddIns (hostViewOfAddIn As Type, location As PipelineStoreLocation) As Collection(Of AddInToken)" />
<MemberSignature Language="F#" Value="static member FindAddIns : Type * System.AddIn.Hosting.PipelineStoreLocation -> System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken>" Usage="System.AddIn.Hosting.AddInStore.FindAddIns (hostViewOfAddIn, location)" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Collections::ObjectModel::Collection<System::AddIn::Hosting::AddInToken ^> ^ FindAddIns(Type ^ hostViewOfAddIn, System::AddIn::Hosting::PipelineStoreLocation location);" />
<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">
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-3.5">
<AttributeName Language="C#">[System.Security.SecurityTreatAsSafe]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityTreatAsSafe>]</AttributeName>
</Attribute>
<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;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostViewOfAddIn" Type="System.Type" />
<Parameter Name="location" Type="System.AddIn.Hosting.PipelineStoreLocation" />
</Parameters>
<Docs>
<param name="hostViewOfAddIn">The type that defines the host's view of the add-in.</param>
<param name="location">The host application's base directory.</param>
<summary>Finds all add-ins for a specified host view of the add-in at a location specified by the <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> enumeration value.</summary>
<returns>A collection of tokens that represent the add-ins that were found.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.AddIn.Hosting.PipelineStoreLocation> enumeration currently contains only the <xref:System.AddIn.Hosting.PipelineStoreLocation.ApplicationBase> value, which points to the host's application base directory.
## Examples
The following example finds add-ins at the location specified by the <xref:System.AddIn.Hosting.PipelineStoreLocation> enumeration.
:::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet4":::
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="location" /> is an invalid <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> value.</exception>
</Docs>
</Member>
<Member MemberName="FindAddIns">
<MemberSignature Language="C#" Value="public static System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken> FindAddIns (Type hostViewOfAddIn, System.AddIn.Hosting.PipelineStoreLocation location, params string[] addInFolderPaths);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.ObjectModel.Collection`1<class System.AddIn.Hosting.AddInToken> FindAddIns(class System.Type hostViewOfAddIn, valuetype System.AddIn.Hosting.PipelineStoreLocation location, string[] addInFolderPaths) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.FindAddIns(System.Type,System.AddIn.Hosting.PipelineStoreLocation,System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FindAddIns (hostViewOfAddIn As Type, location As PipelineStoreLocation, ParamArray addInFolderPaths As String()) As Collection(Of AddInToken)" />
<MemberSignature Language="F#" Value="static member FindAddIns : Type * System.AddIn.Hosting.PipelineStoreLocation * string[] -> System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken>" Usage="System.AddIn.Hosting.AddInStore.FindAddIns (hostViewOfAddIn, location, addInFolderPaths)" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Collections::ObjectModel::Collection<System::AddIn::Hosting::AddInToken ^> ^ FindAddIns(Type ^ hostViewOfAddIn, System::AddIn::Hosting::PipelineStoreLocation location, ... cli::array <System::String ^> ^ addInFolderPaths);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostViewOfAddIn" Type="System.Type" />
<Parameter Name="location" Type="System.AddIn.Hosting.PipelineStoreLocation" />
<Parameter Name="addInFolderPaths" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="hostViewOfAddIn">The type that defines the host's view of the add-in.</param>
<param name="location">One of the enumeration values.
Currently the only value in this enumeration is the directory specified by the <see cref="P:System.AppDomainSetup.ApplicationBase" /> property that was used to set up the host's application domain.</param>
<param name="addInFolderPaths">(Optional). The path of the directory that contains one or more subdirectories of add-ins. Because this parameter takes an array of strings, you can specify more than one path.
This parameter is not required if your add-ins are located in the pipeline directory structure under the AddIns folder.</param>
<summary>Finds all add-ins for a specified host view of the add-in at the location specified by a <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> value and an optional add-ins folder.</summary>
<returns>A collection of tokens that represent the add-ins that were found.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method overload to enable a partially trusted host, which may not have path discovery permission to discover its own location, to find add-ins in its own directory.
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="location" /> is an invalid <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> value.</exception>
</Docs>
</Member>
<Member MemberName="FindAddIns">
<MemberSignature Language="C#" Value="public static System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken> FindAddIns (Type hostViewOfAddIn, string pipelineRootFolderPath, params string[] addInFolderPaths);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.ObjectModel.Collection`1<class System.AddIn.Hosting.AddInToken> FindAddIns(class System.Type hostViewOfAddIn, string pipelineRootFolderPath, string[] addInFolderPaths) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.FindAddIns(System.Type,System.String,System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FindAddIns (hostViewOfAddIn As Type, pipelineRootFolderPath As String, ParamArray addInFolderPaths As String()) As Collection(Of AddInToken)" />
<MemberSignature Language="F#" Value="static member FindAddIns : Type * string * string[] -> System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken>" Usage="System.AddIn.Hosting.AddInStore.FindAddIns (hostViewOfAddIn, pipelineRootFolderPath, addInFolderPaths)" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::Collections::ObjectModel::Collection<System::AddIn::Hosting::AddInToken ^> ^ FindAddIns(Type ^ hostViewOfAddIn, System::String ^ pipelineRootFolderPath, ... cli::array <System::String ^> ^ addInFolderPaths);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostViewOfAddIn" Type="System.Type" />
<Parameter Name="pipelineRootFolderPath" Type="System.String" />
<Parameter Name="addInFolderPaths" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="hostViewOfAddIn">The type that defines the host's view of the add-in.</param>
<param name="pipelineRootFolderPath">The path of the root of the pipeline directory structure.</param>
<param name="addInFolderPaths">(Optional). The path of the directory that contains one or more subdirectories of add-ins. Because this parameter takes an array of strings, you can specify more than one path.
This parameter is not required if your add-ins are located in the pipeline directory structure under the AddIns folder.</param>
<summary>Finds all add-ins for a specified host view of the add-in from a specified root directory.</summary>
<returns>A collection of tokens that represent the add-ins that were found.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method examines the store files of cached add-in and pipeline segment information to find all add-ins that match a specified `hostAddInView` type. You can then use one of the tokens in the returned <xref:System.AddIn.Hosting.AddInToken> collection to activate a specific add-in by calling the <xref:System.AddIn.Hosting.AddInToken.Activate%2A> method of the <xref:System.AddIn.Hosting.AddInToken> class.
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
<altmember cref="M:System.AddIn.Hosting.AddInStore.FindAddIn(System.Type,System.String,System.String,System.String)" />
</Docs>
</Member>
<MemberGroup MemberName="Rebuild">
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Rebuilds the pipeline segments cache and includes new segments.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Rebuild">
<MemberSignature Language="C#" Value="public static string[] Rebuild (System.AddIn.Hosting.PipelineStoreLocation location);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string[] Rebuild(valuetype System.AddIn.Hosting.PipelineStoreLocation location) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.Rebuild(System.AddIn.Hosting.PipelineStoreLocation)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Rebuild (location As PipelineStoreLocation) As String()" />
<MemberSignature Language="F#" Value="static member Rebuild : System.AddIn.Hosting.PipelineStoreLocation -> string[]" Usage="System.AddIn.Hosting.AddInStore.Rebuild location" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::String ^> ^ Rebuild(System::AddIn::Hosting::PipelineStoreLocation location);" />
<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">
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-3.5">
<AttributeName Language="C#">[System.Security.SecurityTreatAsSafe]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityTreatAsSafe>]</AttributeName>
</Attribute>
<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;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="location" Type="System.AddIn.Hosting.PipelineStoreLocation" />
</Parameters>
<Docs>
<param name="location">One of the enumeration values.
Currently the only value in this enumeration is the directory specified by the <see cref="P:System.AppDomainSetup.ApplicationBase" /> property that was used to set up the host's application domain.</param>
<summary>Rebuilds the pipeline segments cache and includes new segments at the location specified by a <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> value.</summary>
<returns>A collection of strings that describe warnings as the pipeline segments are evaluated.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method overload to enable a partially trusted host, which may not have permission to discover its own location, to discover add-ins in its own directory.
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.AddInSegmentDirectoryNotFoundException">A segment directory is missing from the pipeline directory structure.</exception>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="location" /> is an invalid <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> value.</exception>
</Docs>
</Member>
<Member MemberName="Rebuild">
<MemberSignature Language="C#" Value="public static string[] Rebuild (string pipelineRootFolderPath);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string[] Rebuild(string pipelineRootFolderPath) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.Rebuild(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Rebuild (pipelineRootFolderPath As String) As String()" />
<MemberSignature Language="F#" Value="static member Rebuild : string -> string[]" Usage="System.AddIn.Hosting.AddInStore.Rebuild pipelineRootFolderPath" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::String ^> ^ Rebuild(System::String ^ pipelineRootFolderPath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pipelineRootFolderPath" Type="System.String" />
</Parameters>
<Docs>
<param name="pipelineRootFolderPath">The path of the root of the pipeline directory structure.</param>
<summary>Rebuilds the pipeline segments cache and includes new segments from a specified root directory.</summary>
<returns>A collection of strings that describe warnings as the pipeline segments are evaluated.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method also rebuilds the add-ins cache if the add-ins are in the pipeline directory structure.
Use this method only when there may be a problem with the cache and it must be rebuilt. For faster performance, use the <xref:System.AddIn.Hosting.AddInStore.Update%2A> method.
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.AddInSegmentDirectoryNotFoundException">A segment directory is missing from the pipeline directory structure.</exception>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
<altmember cref="M:System.AddIn.Hosting.AddInStore.Update(System.String)" />
</Docs>
</Member>
<Member MemberName="RebuildAddIns">
<MemberSignature Language="C#" Value="public static string[] RebuildAddIns (string addInsFolderPath);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string[] RebuildAddIns(string addInsFolderPath) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.RebuildAddIns(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function RebuildAddIns (addInsFolderPath As String) As String()" />
<MemberSignature Language="F#" Value="static member RebuildAddIns : string -> string[]" Usage="System.AddIn.Hosting.AddInStore.RebuildAddIns addInsFolderPath" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::String ^> ^ RebuildAddIns(System::String ^ addInsFolderPath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="addInsFolderPath" Type="System.String" />
</Parameters>
<Docs>
<param name="addInsFolderPath">The path of the directory that contains one or more subdirectories of add-ins.</param>
<summary>Rebuilds the add-in cache and includes new add-ins from a specified root directory.</summary>
<returns>A collection of strings that describe warnings as the pipeline segments are evaluated.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Call this method if your add-ins are outside the pipeline directory structure.
Use this method only when there may be a problem with the cache and it must be rebuilt. For faster performance, use the <xref:System.AddIn.Hosting.AddInStore.UpdateAddIns%2A> method.
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.AddInSegmentDirectoryNotFoundException">A segment directory is missing from the pipeline directory structure.</exception>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="addInsFolderPath" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">Caller does not have both read and write access permissions to the location that is specified by <paramref name="addInsFolderPath" />.</exception>
<altmember cref="M:System.AddIn.Hosting.AddInStore.UpdateAddIns(System.String)" />
</Docs>
</Member>
<MemberGroup MemberName="Update">
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Updates the pipeline segments cache with new segments.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Update">
<MemberSignature Language="C#" Value="public static string[] Update (System.AddIn.Hosting.PipelineStoreLocation location);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string[] Update(valuetype System.AddIn.Hosting.PipelineStoreLocation location) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.Update(System.AddIn.Hosting.PipelineStoreLocation)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Update (location As PipelineStoreLocation) As String()" />
<MemberSignature Language="F#" Value="static member Update : System.AddIn.Hosting.PipelineStoreLocation -> string[]" Usage="System.AddIn.Hosting.AddInStore.Update location" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::String ^> ^ Update(System::AddIn::Hosting::PipelineStoreLocation location);" />
<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">
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-3.5">
<AttributeName Language="C#">[System.Security.SecurityTreatAsSafe]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityTreatAsSafe>]</AttributeName>
</Attribute>
<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;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="location" Type="System.AddIn.Hosting.PipelineStoreLocation" />
</Parameters>
<Docs>
<param name="location">One of the enumeration values.
Currently the only value in this enumeration is the directory as specified by the <see cref="P:System.AppDomainSetup.ApplicationBase" /> property that was used to set up the host's application domain.</param>
<summary>Updates the pipeline segments cache with new segments at the location specified by a <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> value.</summary>
<returns>A collection of strings that describe warnings as the pipeline segments are evaluated.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this method overload to enable a partially trusted host, which may not have permission to discover its own location, to discover add-ins in its own directory.
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.AddInSegmentDirectoryNotFoundException">A segment directory is missing from the pipeline directory structure.</exception>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="location" /> is an invalid <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> value.</exception>
</Docs>
</Member>
<Member MemberName="Update">
<MemberSignature Language="C#" Value="public static string[] Update (string pipelineRootFolderPath);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string[] Update(string pipelineRootFolderPath) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.Update(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Update (pipelineRootFolderPath As String) As String()" />
<MemberSignature Language="F#" Value="static member Update : string -> string[]" Usage="System.AddIn.Hosting.AddInStore.Update pipelineRootFolderPath" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::String ^> ^ Update(System::String ^ pipelineRootFolderPath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pipelineRootFolderPath" Type="System.String" />
</Parameters>
<Docs>
<param name="pipelineRootFolderPath">The path of the root of the pipeline directory structure.</param>
<summary>Updates the pipeline segments cache with new segments from a specified root directory.</summary>
<returns>A collection of strings that describe warnings as the pipeline segments are evaluated.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method also updates the add-ins cache if the add-ins are in the pipeline directory structure.
If there are no new pipeline segments or add-ins, this method just validates the cache.
## Examples
The following example shows how to update the cache files. This code example is part of a larger example provided for the <xref:System.AddIn.Hosting.AddInStore> class.
:::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet3":::
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.AddInSegmentDirectoryNotFoundException">A segment directory is missing from the pipeline directory structure.</exception>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
</Docs>
</Member>
<Member MemberName="UpdateAddIns">
<MemberSignature Language="C#" Value="public static string[] UpdateAddIns (string addInsFolderPath);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string[] UpdateAddIns(string addInsFolderPath) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Hosting.AddInStore.UpdateAddIns(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function UpdateAddIns (addInsFolderPath As String) As String()" />
<MemberSignature Language="F#" Value="static member UpdateAddIns : string -> string[]" Usage="System.AddIn.Hosting.AddInStore.UpdateAddIns addInsFolderPath" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::String ^> ^ UpdateAddIns(System::String ^ addInsFolderPath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="addInsFolderPath" Type="System.String" />
</Parameters>
<Docs>
<param name="addInsFolderPath">The path of the directory that contains one or more subdirectories of add-ins.</param>
<summary>Updates the add-in cache and includes new add-ins at a specified location.</summary>
<returns>A collection of strings that describe warnings as the pipeline segments are evaluated.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Call this method if your add-ins are outside the pipeline directory structure.
If no new add-ins are installed, this method just validates the cache.
]]></format>
</remarks>
<exception cref="T:System.AddIn.Hosting.AddInSegmentDirectoryNotFoundException">A segment directory is missing from the pipeline directory structure.</exception>
<exception cref="T:System.AddIn.Hosting.InvalidPipelineStoreException">There is an access violation to the pipeline directory structure.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="addInsFolderPath" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">Caller does not have both read and write access permissions to the location that is specified by <paramref name="addInsFolderPath" />.</exception>
</Docs>
</Member>
</Members>
</Type>