AddInStore Class

Definition

Namespace:

System.AddIn.Hosting

Assembly:

System.AddIn.dll

Provides methods to store and find information about available add-ins and pipeline segments.

public ref class AddInStore abstract sealed

public static class AddInStore

type AddInStore = class

Public Class AddInStore

Inheritance

Object

AddInStore

Examples

The following example shows how to update cache files.

// Get path for the pipeline root.
// Assumes that the current directory is the
// pipeline directory structure root directory.
String pipeRoot = Environment.CurrentDirectory;

// Update the cache files of the
// pipeline segments and add-ins.
string[] warnings = AddInStore.Update(pipeRoot);

foreach (string warning in warnings)
{
    Console.WriteLine(warning);
}

// Search for add-ins of type Calculator (the host view of the add-in)
// specifying the host's application base, instead of a path,
// for the FindAddIns method.

Collection<AddInToken> tokens =
            AddInStore.FindAddIns(typeof(Calculator), PipelineStoreLocation.ApplicationBase);

' Get the path for the pipeline root.  
' Assumes that the current directory is the
' pipline directory structure root directory.
Dim pipeRoot As String = Environment.CurrentDirectory
' Update the cache files of the
' pipeline segments and add-ins.
Dim warnings() As String = AddInStore.Update(pipeRoot)
For Each warning As String In warnings
    Console.WriteLine(warning)
Next

' Search for add-ins of type Calculator (the host view of the add-in)
' specifying the host's application base, instead of a path,
' for the FindAddIns method.
Dim tokens As Collection(Of AddInToken) = _
    AddInStore.FindAddIns(GetType(Calculator), PipelineStoreLocation.ApplicationBase)

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 This file is located in the root directory of the pipeline directory structure.	Update Updates the file with new pipeline segments. If no new segments are installed, this method just validates the cache. Rebuild Rebuilds the file and includes new pipeline segments.
AddIns.store 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.	UpdateAddIns Updates the file with new add-ins at a specified location. 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. RebuildAddIns Rebuilds the file and includes add-ins at a specified location. Call this method if your add-ins are outside the pipeline directory structure. Update If the add-ins are in the pipeline directory structure, this method updates the file with new add-ins. Rebuild 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 FindAddIns 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 FindAddIn 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.

Methods

FindAddIn(Type, String, String, String)	Finds a specific add-in.
FindAddIns(Type, PipelineStoreLocation)	Finds all add-ins for a specified host view of the add-in at a location specified by the PipelineStoreLocation enumeration value.
FindAddIns(Type, PipelineStoreLocation, String[])	Finds all add-ins for a specified host view of the add-in at the location specified by a PipelineStoreLocation value and an optional add-ins folder.
FindAddIns(Type, String, String[])	Finds all add-ins for a specified host view of the add-in from a specified root directory.
Rebuild(PipelineStoreLocation)	Rebuilds the pipeline segments cache and includes new segments at the location specified by a PipelineStoreLocation value.
Rebuild(String)	Rebuilds the pipeline segments cache and includes new segments from a specified root directory.
RebuildAddIns(String)	Rebuilds the add-in cache and includes new add-ins from a specified root directory.
Update(PipelineStoreLocation)	Updates the pipeline segments cache with new segments at the location specified by a PipelineStoreLocation value.
Update(String)	Updates the pipeline segments cache with new segments from a specified root directory.
UpdateAddIns(String)	Updates the add-in cache and includes new add-ins at a specified location.

See also

• Add-Ins and Extensibility