Rozhraní IVsSettingsWriter

Článek
01/23/2017

Poskytuje mechanismus pro ukládání informací o konfiguraci v VSPackage Visual Studio souboru s nastavením.

Obor názvů: Microsoft.VisualStudio.Shell.Interop
Sestavení: Microsoft.VisualStudio.Shell.Interop.8.0 (v Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntaxe

[GuidAttribute("0F1CF980-AFC6-406E-958D-7F24287E3916")]
[InterfaceTypeAttribute(1)]
public interface IVsSettingsWriter

[GuidAttribute("0F1CF980-AFC6-406E-958D-7F24287E3916")]
[InterfaceTypeAttribute(1)]
public interface class IVsSettingsWriter

[<GuidAttribute("0F1CF980-AFC6-406E-958D-7F24287E3916")>]
[<InterfaceTypeAttribute(1)>]
type IVsSettingsWriter = interface end

<GuidAttribute("0F1CF980-AFC6-406E-958D-7F24287E3916")>
<InterfaceTypeAttribute(1)>
Public Interface IVsSettingsWriter

Metody

	Název	Popis
	ReportError(String, UInt32)	Chybový stav operace zápisu souboru nastavení sestavy.
	WriteCategoryVersion(Int32, Int32, Int32, Int32)	Nastaví hodnotu uložené v objektu verze kategorie Visual Studio souboru s nastavením.
	WriteSettingAttribute(String, String, String)
	WriteSettingBoolean(String, Int32)	Uloží hodnotu objektu Boolean v Visual Studio souboru s nastavením.
	WriteSettingBytes(String, Byte[], Int32)	Ukládá hodnoty pole v Visual Studio souboru s nastavením.
	WriteSettingLong(String, Int32)	Uloží hodnotu Long objektu v Visual Studio souboru s nastavením.
	WriteSettingString(String, String)	Ukládá hodnotu řetězce v Visual Studio souboru s nastavením.
	WriteSettingXml(Object)	Uloží hodnotu objektu XML v Visual Studio souboru s nastavením.
	WriteSettingXmlFromString(String)	Uloží hodnotu nastavení XML jako objekt řetězec v Visual Studio souboru s nastavením.

Poznámky

Toto rozhraní je implementováno prostředí.

Poznámky pro volající

Volání IVsSettingsWriter Při ukládání VSPackage konfigurační informace do Visual Studio souboru s nastavením.

Poznámky pro implementátory

Pouze VSPackage, která jste zaregistrovali jejich podporu Visual Studio nastavení provést mechanismus použití IVsSettingsWriter. Další informace o registraci VSPackage jako podpůrný Visual Studio mechanismus nastavení najdete v části podporu pro uživatelská nastavení.

Pokud byl vybrán operace exportu nastavení z Nastavení importu a exportu funkce, které jsou k dispozici v rozhraní IDE Nástroje nabídky, předá prostředí IVsSettingsWriter rozhraní VSPackage nastavení exportu metodě, která používá rozhraní k zápisu dat konfigurace.Visual Studio SDK Podporuje několik metod exportu:

Definiční sestavení na základě VSPackage, je metoda exportu sady VSPackage provádění IVsUserSettings rozhraní ExportSettings.
Pro většinu Managed balíček Framework založené VSPackage, je metoda exportu sady VSPackage provádění IProfileManager rozhraní SaveSettingsToXml.
Pro spravované Framework balíček na základě implementace VSPackage DialogPage rozhraní, metoda exportu je toto rozhraní SaveSettingsToXml.

Další informace naleznete v tématu Postupy: Export nastavení podle pomocí zprostředkovatele komunikace s objekty sestavení nebo Export nastavení.

[!POZNÁMKA]

Kromě všechna data uložená pomocí IVsSettingsWriter metod, rozhraní IDE vždy transparentně ukládá verze Visual Studio používá k exportu konfigurační data.

[!POZNÁMKA]

Osvědčeným postupem při ukládání vyrovnávací paměti nebo řetězec je uložit velikost vyrovnávací paměti uložené nebo řetězec, a také s samotného objektu. Informace o této velikosti by měla vždy použít při načítání uložené vyrovnávací paměť řetězce aby se zabránilo přetečení vyrovnávací paměti.

Příklady

V následujícím příkladu je metoda volána implementace ExportSettings, metoda zapíše tři nastavení hodnoty, z nichž jeden je velikost vyrovnávací paměti, který bude uložen.

HRESULT ExportSettings_CommandBars(IVsSettingsWriter *pSettings)
{
    if (!pSettings)
        return E_INVALIDARG;

    hr = pSettings->WriteSettingString(c_szFirstSettingName, L"Value1");
    IfFailGo(hr);

    int cRandomTrash = 12345;
    BYTE *pRandomTrash = (BYTE *)VSAlloc(cRandomTrash);
    if (pRandomTrash){
        hr = pSettings->WriteSettingBytes(c_szRandomTrashBytes, pRandomTrash, cRandomTrash);
        IfFailGo(hr);
        hr = pSettings->WriteSettingLong(c_szRandomTrashLength, cRandomTrash);
        IfFailGo(hr);
    }

 Error:
    return hr;
};

Viz také

IVsSettingsReader
ExportSettings
Obory názvů Microsoft.VisualStudio.Shell.Interop
Podpora pro uživatelská nastavení
Postupy: Export nastavení pomocí sestavení vzájemné spolupráce
Export nastavení
Working with Settings

Zpět na začátek

Sdílet prostřednictvím