Guardar datos en archivos de proyecto

  • Artículo

Un subtipo de proyecto puede guardar y recuperar datos específicos del subtipo en el archivo del proyecto. Managed Package Framework (MPF) proporciona dos interfaces para realizar esta tarea:

  • La IVsBuildPropertyStorage interfaz permite acceder a los valores de propiedad desde la sección MSBuild del archivo del proyecto. Cualquier usuario puede llamar a los métodos proporcionados por IVsBuildPropertyStorage cada usuario siempre que el usuario necesite cargar o guardar los datos relacionados con la compilación.

  • IPersistXMLFragment se usa para conservar datos no relacionados con la compilación en XML de forma libre. Visual Studio llama a los métodos proporcionados por IPersistXMLFragment cada vez que Visual Studio necesita conservar datos relacionados con la compilación en el archivo del proyecto.

    Para obtener más información sobre cómo conservar los datos relacionados con la compilación y no la compilación, consulte Persist data in the MSBuild project file (Conservar datos en el archivo de proyecto de MSBuild).

  • Llame al SetPropertyValue método para guardar una ruta de acceso completa del archivo del proyecto.

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

  • Llame al GetPropertyValue método para recuperar una ruta de acceso completa del archivo del proyecto.

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

  1. Implemente el IsFragmentDirty método para determinar si un fragmento XML ha cambiado desde que se guardó por última vez en su archivo actual.

    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. Implemente el Save método para guardar los datos XML en el archivo del proyecto.

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

  1. Implemente el InitNew método para inicializar las propiedades de la extensión del proyecto y otros datos independientes de la compilación. Se llama a este método si no hay ningún dato de configuración XML presente en el archivo del proyecto.

    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. Implemente el Load método para cargar los datos XML desde el archivo del proyecto.

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

Nota:

Todos los ejemplos de código proporcionados en este tema son partes de un ejemplo mayor en ejemplos de VSSDK.

Contenido relacionado