プロジェクトファイルにデータを保存する

[アーティクル]
01/13/2024

プロジェクトサブタイプを使用すると、サブタイプ固有のデータをプロジェクトファイルに保存および取得できます。 Managed Package Framework (MPF) には、このタスクを実行するための 2 つのインターフェイスが用意されています。

IVsBuildPropertyStorage インターフェイスを使用すると、プロジェクトファイルの MSBuild セクションからプロパティ値にアクセスできます。 IVsBuildPropertyStorage に用意されているメソッドは、ユーザーがビルド関連データを読み込むまたは保存する必要があるときはいつでも、任意のユーザーが呼び出すことができます。
IPersistXMLFragment は、非ビルド関連データを自由形式の XML で保持するために使用されます。 IPersistXMLFragment に用意されているメソッドは、Visual Studio により、非ビルド関連データをプロジェクトファイルに保持する必要がある場合は常に、Visual Studio によって呼び出されます。

ビルド関連データと非ビルド関連データを保持する方法の詳細については、MSBuild プロジェクトファイルへのデータの保持に関するページを参照してください。

SetPropertyValue メソッドを呼び出して、プロジェクトファイルの完全なパスを保存します。

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

GetPropertyValue メソッドを呼び出して、プロジェクトファイルの完全なパスを取得します。

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

XML フラグメントが現在のファイルに最後に保存されてから変更されたかどうかを判断するには、IsFragmentDirty メソッドを実装します。

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;

}

XML データをプロジェクトファイルに保存するには、Save メソッドを実装します。

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

プロジェクト拡張プロパティとその他のビルドに依存しないデータを初期化するには、InitNew メソッドを実装します。このメソッドは、プロジェクトファイルに 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;

プロジェクトファイルから XML データを読み込むには、Load メソッドを実装します。

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

Note

このトピックで取り上げるすべてのコード例は、VSSDK サンプルの大きな例の一部です。

MSBuild プロジェクトファイルにデータを保持する

プロジェクト ファイルにデータを保存する

ビルド関連データの保存と取得

ビルド関連データをプロジェクト ファイルに保存するには

プロジェクト ファイルからビルド関連データを取得するには

非ビルド関連データの保存と取得

非ビルド関連データをプロジェクト ファイルに保存するには

非ビルド関連データをプロジェクト ファイルに取得するには

関連するコンテンツ

その他のリソース

プロジェクトファイルにデータを保存する

ビルド関連データをプロジェクトファイルに保存するには

プロジェクトファイルからビルド関連データを取得するには

非ビルド関連データをプロジェクトファイルに保存するには

非ビルド関連データをプロジェクトファイルに取得するには