AddInStore.FindAddIn(Type, String, String, String) AddInStore.FindAddIn(Type, String, String, String) AddInStore.FindAddIn(Type, String, String, String) AddInStore.FindAddIn(Type, String, String, String) Method

Definition

Finds a specific add-in.

public:
 static System::Collections::ObjectModel::Collection<System::AddIn::Hosting::AddInToken ^> ^ FindAddIn(Type ^ hostViewOfAddIn, System::String ^ pipelineRootFolderPath, System::String ^ addInFilePath, System::String ^ addInTypeName);
[System.Security.SecurityCritical]
public static System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken> FindAddIn (Type hostViewOfAddIn, string pipelineRootFolderPath, string addInFilePath, string addInTypeName);
static member FindAddIn : Type * string * string * string -> System.Collections.ObjectModel.Collection<System.AddIn.Hosting.AddInToken>
Public Shared Function FindAddIn (hostViewOfAddIn As Type, pipelineRootFolderPath As String, addInFilePath As String, addInTypeName As String) As Collection(Of AddInToken)

Parameters

hostViewOfAddIn
Type Type Type Type

The type that defines the host's view of the add-in.

pipelineRootFolderPath
String String String String

The path to the root of the pipeline directory structure.

addInFilePath
String String String String

The path and file name of the add-in to find.

addInTypeName
String String String String

The type name of the add-in.

Returns

A collection of tokens that contains only the token representing the add-in that was found.

Exceptions

The length of pipelineRootFolderPath or addInFilePath or addInTypeName is 0.

-or-

The add-in file does not exist in addInfilePath.

The caller does not have read access permission to pipelineRootFolderPath.

Examples

The following example finds a specific add-in.

// Find a specific add-in.

// Construct the path to the add-in.
string addInFilePath = pipeRoot + @"\AddIns\P3AddIn2\P3AddIn2.dll";

// The fourth parameter, addinTypeName, takes the full name 
// of the type qualified by its namespace. Same as AddInToken.AddInFullName.
Collection<AddInToken> tokenColl = AddInStore.FindAddIn(typeof(Calculator),
    pipeRoot, addInFilePath, "CalcAddIns.P3AddIn2");
Console.WriteLine("Found {0}", tokenColl[0].Name);
' Find a specific add-in.
' Construct the path to the add-in.
Dim addInFilePath As String = (pipeRoot + "\AddIns\P3AddIn2\P3AddIn2.dll")
' The fourth parameter, addinTypeName, takes the full name 
' of the type qualified by its namespace. Same as AddInToken.AddInFullName.
Dim tokenColl As System.Collections.ObjectModel.Collection(Of AddInToken) = AddInStore.FindAddIn(GetType(Calculator), pipeRoot, addInFilePath, "CalcAddIns.P3AddIn2")
Console.WriteLine("Found {0}", tokenColl(0).Name)

Remarks

If a single pipeline for an add-in is found, it will be the only item in the AddInToken collection. If multiple pipelines to the specified add-in are found, you can differentiate them by examining the QualificationData property.

Security

FileIOPermission
for the ability to read the add-in folder. Associated enumeration: Read. Security action: Demand.

Applies to

See also