Zapisywanie danych w plikach projektu

Podtyp projektu może zapisywać i pobierać dane specyficzne dla podtypu w pliku projektu. Program Managed Package Framework (MPF) udostępnia dwa interfejsy umożliwiające wykonanie tego zadania:

• Interfejs IVsBuildPropertyStorage umożliwia dostęp do wartości właściwości z sekcji MSBuild pliku projektu. Metody udostępniane przez IVsBuildPropertyStorage program mogą być wywoływane przez dowolnego użytkownika za każdym razem, gdy użytkownik musi załadować lub zapisać dane powiązane z kompilacją.

• Element IPersistXMLFragment służy do utrwalania danych niezwiązanych z kompilacją w formacie XML w postaci wolnej. Metody udostępniane przez IPersistXMLFragment program są wywoływane przez program Visual Studio zawsze, gdy program Visual Studio musi utrwalać dane powiązane z kompilacją w pliku projektu.

  Aby uzyskać więcej informacji na temat utrwalania danych kompilacji i niezwiązanych z kompilacją, zobacz Utrwalanie danych w pliku projektu MSBuild.

Zapisywanie i pobieranie danych powiązanych z kompilacją

Aby zapisać dane powiązane z kompilacją w pliku projektu

• Wywołaj metodę , SetPropertyValue aby zapisać pełną ścieżkę pliku projektu.

  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));
  

Aby pobrać dane powiązane z kompilacją z pliku projektu

• Wywołaj metodę , GetPropertyValue aby pobrać pełną ścieżkę pliku projektu.

  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));
  

Zapisywanie i pobieranie danych niezwiązanych z kompilacją

Aby zapisać dane niezwiązane z kompilacją w pliku projektu

1. Zaimplementuj metodę, IsFragmentDirty aby określić, czy fragment XML uległ zmianie od czasu ostatniego zapisania do bieżącego pliku.

   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. Zaimplementuj metodę , Save aby zapisać dane XML w pliku projektu.

   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;
   }
   

Aby pobrać dane niezwiązane z kompilacją w pliku projektu

1. Zaimplementuj metodę InitNew w celu zainicjowania właściwości rozszerzenia projektu i innych danych niezależnych od kompilacji. Ta metoda jest wywoływana, jeśli w pliku projektu nie ma żadnych danych konfiguracji XML.

   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. Zaimplementuj metodę w Load celu załadowania danych XML z pliku projektu.

   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;
   }
   

Uwaga

Wszystkie przykłady kodu podane w tym temacie są częścią większego przykładu w przykładach zestawu VSSDK.

Powiązana zawartość

• Utrwalanie danych w pliku projektu MSBuild