Speichern von Daten in Projektdateien

Ein Projektuntertyp kann untertypspezifische Daten in der Projektdatei speichern und abrufen. Das Verwaltete Paketframework (Managed Package Framework, MPF) stellt zwei Schnittstellen bereit, um diese Aufgabe auszuführen:

• Die IVsBuildPropertyStorage Schnittstelle ermöglicht den Zugriff auf Eigenschaftswerte aus dem MSBuild-Abschnitt der Projektdatei. Die von IVsBuildPropertyStorage jedem Benutzer bereitgestellten Methoden können aufgerufen werden, wenn der Benutzer buildbezogene Daten laden oder speichern muss.

• Dies IPersistXMLFragment wird verwendet, um nicht buildbezogene Daten in Freiform-XML zu speichern. Die von IPersistXMLFragment Visual Studio bereitgestellten Methoden werden aufgerufen, wenn Visual Studio nicht buildbezogene Daten in der Projektdatei beibehalten muss.

  Weitere Informationen zum Beibehalten von Build- und nicht buildbezogenen Daten finden Sie unter Persist data in the MSBuild project file.

Speichern und Abrufen von buildbezogenen Daten

So speichern Sie buildbezogene Daten in der Projektdatei

• Rufen Sie die SetPropertyValue Methode auf, um einen vollständigen Pfad der Projektdatei zu speichern.

  private SpecializedProject project;
  IVsBuildPropertyStorage projectStorage = (IVsBuildPropertyStorage)project;
  string newFullPath = GetNewFullPath();
  // Set a full path of the project file.
  ErrorHandler.ThrowOnFailure(projectStorage.SetPropertyValue(
      "MSBuildProjectDirectory",
      String.Empty,
      (uint)_PersistStorageType.PST_PROJECT_FILE, newFullPath));
  

So rufen Sie buildbezogene Daten aus der Projektdatei ab

• Rufen Sie die GetPropertyValue Methode auf, um einen vollständigen Pfad der Projektdatei abzurufen.

  private SpecializedProject project;
  IVsBuildPropertyStorage projectStorage = (IVsBuildPropertyStorage)project;
  string fullPath;
  // Get a full path of the project file.
  ErrorHandler.ThrowOnFailure(projectStorage.GetPropertyValue(
      "MSBuildProjectDirectory",
      String.Empty,
      (uint)_PersistStorageType.PST_PROJECT_FILE, out fullPath));
  

Speichern und Abrufen von nicht buildbezogenen Daten

So speichern Sie nicht buildbezogene Daten in der Projektdatei

1. Implementieren Sie die IsFragmentDirty Methode, um zu ermitteln, ob sich ein XML-Fragment seit dem letzten Speichern in der aktuellen Datei geändert hat.

   public int IsFragmentDirty(uint storage, out int pfDirty)
   {
       pfDirty = 0;
       switch (storage)
       {
           case (uint)_PersistStorageType.PST_PROJECT_FILE:
           {
               if (isDirty)
                   pfDirty |= 1;
               break;
           }
           case (uint)_PersistStorageType.PST_USER_FILE:
           {
               // We do not store anything in the user file.
               break;
           }
       }
   
       // Forward the call to inner flavor(s)
       if (pfDirty == 0 && innerCfg != null && this.innerCfg is IPersistXMLFragment)
           return ((IPersistXMLFragment)this.innerCfg).IsFragmentDirty(storage, out pfDirty);
   
       return VSConstants.S_OK;
   
   }
   

2. Implementieren Sie die Methode zum Speichern der Save XML-Daten in der Projektdatei.

   public int Save(ref Guid guidFlavor, uint storage, out string pbstrXMLFragment, int fClearDirty)
   {
       pbstrXMLFragment = null;
   
       if (IsMyFlavorGuid(ref guidFlavor))
       {
           switch (storage)
           {
               case (uint)_PersistStorageType.PST_PROJECT_FILE:
               {
                   // Create XML for our data.
                   XmlDocument doc = new XmlDocument();
                   XmlNode root = doc.CreateElement(this.GetType().Name);
   
                   XmlNode node = doc.CreateElement(targetsTag);
                   node.AppendChild(doc.CreateTextNode(this.TargetsToExecute));
                   root.AppendChild(node);
   
                   node = doc.CreateElement(updateTargetsTag);
                   node.AppendChild(doc.CreateTextNode(this.UpdateTargetList.ToString()));
                   root.AppendChild(node);
   
                   doc.AppendChild(root);
                   // Get XML fragment representing our data
                   pbstrXMLFragment = doc.InnerXml;
   
                   if (fClearDirty != 0)
                       isDirty = false;
                   break;
               }
               case (uint)_PersistStorageType.PST_USER_FILE:
               {
                   // We do not store anything in the user file.
                   break;
               }
           }
       }
   
       // Forward the call to inner flavor(s)
       if (this.innerCfg != null && this.innerCfg is IPersistXMLFragment)
           return ((IPersistXMLFragment)this.innerCfg).Save(ref guidFlavor, storage, out pbstrXMLFragment, fClearDirty);
   
       return VSConstants.S_OK;
   }
   

So rufen Sie nicht buildbezogene Daten in der Projektdatei ab

1. Implementieren Sie die Methode zum Initialisieren der InitNew Projekterweiterungseigenschaften und anderer buildunabhängiger Daten. Diese Methode wird aufgerufen, wenn in der Projektdatei keine XML-Konfigurationsdaten vorhanden sind.

   public int InitNew(ref Guid guidFlavor, uint storage)
   {
       //Return,if it is our guid.
       if (IsMyFlavorGuid(ref guidFlavor))
           return VSConstants.S_OK;
   
       //Forward the call to inner flavor(s).
       if (this.innerCfg != null && this.innerCfg is IPersistXMLFragment)
           return ((IPersistXMLFragment)this.innerCfg).InitNew(ref guidFlavor, storage);
   
       return VSConstants.S_OK;
   

2. Implementieren Sie die Methode zum Laden der Load XML-Daten aus der Projektdatei.

   public int Load(ref Guid guidFlavor, uint storage, string pszXMLFragment)
   {
       if (IsMyFlavorGuid(ref guidFlavor))
       {
           switch (storage)
           {
               case (uint)_PersistStorageType.PST_PROJECT_FILE:
               {
                   // Load our data from the XML fragment.
                   XmlDocument doc = new XmlDocument();
                   XmlNode node = doc.CreateElement(this.GetType().Name);
                   node.InnerXml = pszXMLFragment;
                   if (node == null
                       || node.FirstChild == null
                       || node.FirstChild.ChildNodes.Count == 0
                       || node.FirstChild.ChildNodes[0].Name != targetsTag)
                       break;
                   this.TargetsToExecute = node.FirstChild.ChildNodes[0].InnerText;
   
                   if (node.FirstChild.ChildNodes.Count <= 1
                       || node.FirstChild.ChildNodes[1].Name != updateTargetsTag)
                       break;
                   this.UpdateTargetList = bool.Parse(node.FirstChild.ChildNodes[1].InnerText);
                   break;
               }
               case (uint)_PersistStorageType.PST_USER_FILE:
               {
                   // We do not store anything in the user file.
                   break;
               }
           }
       }
   
       // Forward the call to inner flavor(s)
       if (this.innerCfg != null && this.innerCfg is IPersistXMLFragment)
           return ((IPersistXMLFragment)this.innerCfg).Load(ref guidFlavor, storage, pszXMLFragment);
   
       return VSConstants.S_OK;
   }
   

Zugehöriger Inhalt

• Speichern von Daten in der MSBuild-Projektdatei