AddInStore.Update Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Updates the pipeline segments cache with new segments.
Overloads
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. |
Update(PipelineStoreLocation)
Updates the pipeline segments cache with new segments at the location specified by a PipelineStoreLocation value.
public:
static cli::array <System::String ^> ^ Update(System::AddIn::Hosting::PipelineStoreLocation location);
[System.Security.SecurityCritical]
[System.Security.SecurityTreatAsSafe]
public static string[] Update (System.AddIn.Hosting.PipelineStoreLocation location);
public static string[] Update (System.AddIn.Hosting.PipelineStoreLocation location);
[<System.Security.SecurityCritical>]
[<System.Security.SecurityTreatAsSafe>]
static member Update : System.AddIn.Hosting.PipelineStoreLocation -> string[]
static member Update : System.AddIn.Hosting.PipelineStoreLocation -> string[]
Public Shared Function Update (location As PipelineStoreLocation) As String()
Parameters
- location
- PipelineStoreLocation
One of the enumeration values.
Currently the only value in this enumeration is the directory as specified by the ApplicationBase property that was used to set up the host's application domain.
Returns
A collection of strings that describe warnings as the pipeline segments are evaluated.
- Attributes
Exceptions
A segment directory is missing from the pipeline directory structure.
There is an access violation to the pipeline directory structure.
location
is an invalid PipelineStoreLocation value.
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.
Applies to
Update(String)
Updates the pipeline segments cache with new segments from a specified root directory.
public:
static cli::array <System::String ^> ^ Update(System::String ^ pipelineRootFolderPath);
[System.Security.SecurityCritical]
public static string[] Update (string pipelineRootFolderPath);
[<System.Security.SecurityCritical>]
static member Update : string -> string[]
Public Shared Function Update (pipelineRootFolderPath As String) As String()
Parameters
- pipelineRootFolderPath
- String
The path of the root of the pipeline directory structure.
Returns
A collection of strings that describe warnings as the pipeline segments are evaluated.
- Attributes
Exceptions
A segment directory is missing from the pipeline directory structure.
There is an access violation to the pipeline directory structure.
Examples
The following example shows how to update the cache files. This code example is part of a larger example provided for the AddInStore class.
// Update the cache files of the
// pipeline segments and add-ins.
string[] warnings = AddInStore.Update(pipeRoot);
foreach (string warning in warnings)
{
Console.WriteLine(warning);
}
' 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
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.