Udostępnij za pośrednictwem


Interfejs IVsSettingsWriter

 

Udostępnia mechanizm do przechowywania informacji konfiguracyjnych w pakiety VSPackages Visual Studio pliku ustawień.

Przestrzeń nazw:   Microsoft.VisualStudio.Shell.Interop
Zestaw:  Microsoft.VisualStudio.Shell.Interop.8.0 (w Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Składnia

[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

Nazwa Opis
System_CAPS_pubmethod ReportError(String, UInt32)

Informuje o stanie Błąd operacji zapisywania pliku ustawień.

System_CAPS_pubmethod WriteCategoryVersion(Int32, Int32, Int32, Int32)

Ustawia wartość obiektu wersji kategorii przechowywane w Visual Studio pliku ustawień.

System_CAPS_pubmethod WriteSettingAttribute(String, String, String)

System_CAPS_pubmethod WriteSettingBoolean(String, Int32)

Przechowuje wartość logiczna obiektu w Visual Studio pliku ustawień.

System_CAPS_pubmethod WriteSettingBytes(String, Byte[], Int32)

Przechowuje wartości tablicy w Visual Studio pliku ustawień.

System_CAPS_pubmethod WriteSettingLong(String, Int32)

Przechowuje wartość długa obiektu w Visual Studio pliku ustawień.

System_CAPS_pubmethod WriteSettingString(String, String)

Przechowuje wartość ciągu w Visual Studio pliku ustawień.

System_CAPS_pubmethod WriteSettingXml(Object)

Przechowuje wartość obiektu XML w Visual Studio pliku ustawień.

System_CAPS_pubmethod WriteSettingXmlFromString(String)

Przechowuje wartości ustawienia XML jako obiekt ciągu w Visual Studio pliku ustawień.

Uwagi

Ten interfejs jest implementowany przez środowisko.

Uwagi dotyczące wywoływania

Wywołanie IVsSettingsWriter podczas przechowywania informacji konfiguracyjnych VSPackage do Visual Studio pliku ustawień.

Uwagi dotyczące implementacji

Tylko pakiety VSPackages, które zostały zarejestrowane ich obsługę Visual Studio stosowania mechanizmu wprowadzić ustawienia IVsSettingsWriter. Aby uzyskać więcej informacji o rejestrowaniu VSPackage jako obsługujące Visual Studio mechanizmu ustawienia zobacz pomocy technicznej dla ustawień użytkownika.

Podczas operacji eksportowania ustawienie została wybrana z importowania i eksportowania ustawień funkcja dostępna w IDE narzędzia przekazuje środowiska menu IVsSettingsWriter interfejsu do metody eksportu ustawień pakietu VSPackage, która korzysta z interfejsu do zapisywania danych konfiguracji.Visual Studio SDK Obsługuje kilka metod eksportowania:

  • Dla zestawu międzyoperacyjnego opartych na pakiety VSPackages, metoda eksportu jest implementacją VSPackage IVsUserSettings interfejsu ExportSettings.

  • Dla większości Framework pakietu zarządzania opartych na pakiety VSPackages, metoda eksportu jest implementacją VSPackage IProfileManager interfejsu SaveSettingsToXml.

  • Dla zarządzanych Framework pakietu opartych na implementowanie pakiety VSPackages DialogPage interfejsu, metoda eksportu jest ten interfejs SaveSettingsToXml.

Aby uzyskać więcej informacji, zobacz porady: wyeksportować ustawienia za pomocą zestawy międzyoperacyjne lub eksportowania ustawień.

[!UWAGA]

Oprócz wszystkie dane przechowywane za pomocą IVsSettingsWriter metod, IDE zawsze niewidocznie przechowywana wersja Visual Studio używany do eksportowania danych konfiguracji.

[!UWAGA]

Najlepszym rozwiązaniem przechowuje buforów lub ciągu jest zapisanie rozmiar buforu przechowywanych lub ciągu, a także sam obiekt. Informacje o rozmiarze należy zawsze używać podczas pobierania zapisane buforu ciągu w celu uniknięcia przepełnienia buforu.

Przykłady

W poniższym przykładzie jest wywoływana przez implementację metody ExportSettings, metoda zapisuje trzy ustawienia wartości, z których jedna jest rozmiar buforu ma być przechowywany.

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

Zobacz też

IVsSettingsReader
ExportSettings
Przestrzeń nazw Microsoft.VisualStudio.Shell.Interop
Obsługa ustawień użytkownika
Porady: eksportowanie ustawień za pomocą zestawy międzyoperacyjne
Eksportowanie ustawień
Working with Settings

Powrót do początku