Metoda IVsUserSettingsQuery.NeedExport (String, Int32)

Článek
01/23/2017

Určuje, zda zadaná kategorie vyžaduje export jeho nastavení.

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

Syntaxe

int NeedExport(
    string szCategoryGUID,
    out int pfNeedExport
)

int NeedExport(
    String^ szCategoryGUID,
    [OutAttribute] int% pfNeedExport
)

abstract NeedExport : 
        szCategoryGUID:string *
        pfNeedExport:int byref -> int

Function NeedExport (
    szCategoryGUID As String,
    <OutAttribute> ByRef pfNeedExport As Integer
) As Integer

Parametry

szCategoryGUID
Type: System.String

[v] Identifikátor GUID identifikující kategorii konkrétní nastavení (bod vlastní nastavení definované) dotazována.

pfNeedExport
Type: System.Int32

[out] Logická hodnota vrácená označíte, pokud rozhraní IDE by měly volat implementaci nastavení exportu sady VSPackage.

Návratová hodnota

Type: System.Int32

Pokud je metoda úspěšná, vrátí S_OK. Pokud selže, vrátí kód chyby.

Poznámky

Jeden VSPackage může podporovat více než jeden bod nastavení vlastní (kategorie nastavení). Proto implementace NeedExport musí identifikace zkontrolujte zadaná nastavení bodu vlastní na identifikátor GUID nebo nastavení argumentu kategorie k určení, pokud je nutné uložit určitou skupinu nastavení.

Příklady

V tomto příkladu sady VSPackage vždy požádá o uložení stavu příkazového řádku, že byl nastaven pouze požadavky, že ji uložit stavu vazbu klíče příznak.

STDMETHOD(NeedExport)(WCHAR* pszCategoryGUID, BOOL *pfNeedExport)
{
    if (!pfNeedExport)
        return E_INVALIDARG;

    CLSID clsidCategory;
    HRESULT hr= S_OK;

    hr = CLSIDFromString(pszCategoryGUID, &clsidCategory);
    IfFailGo(hr);
    if (GUID_Profiles_CommandBars == clsidCategory) {
        *pfNeedExport = TRUE; //Always export Command Bar Configuration
    }else if (GUID_Profiles_KeyBindings == clsidCategory) {
        *pfNeedExport = FALSE; //By Default don't export key bindings
        if (m_fMake_Permanent)
            *pfNeedExport = TRUE; //Export if user wants current configuration saved.
    }else{
        hr = E_UNEXPECTED;
    }
 Error:
    return hr;
}

Viz také

IVsUserSettings
ImportSettings
Rozhraní IVsUserSettingsQuery
Obory názvů Microsoft.VisualStudio.Shell.Interop
Podpora pro uživatelská nastavení
Postupy: použití sestavení vzájemné spolupráce pro Import nastavení
Working with Settings

Zpět na začátek

Sdílet prostřednictvím