IVsUserSettingsQuery Schnittstelle

Definition

Ermöglicht einem VSPackages, anzugeben, ob die Einstellungen gespeichert werden müssen oder nicht.

public interface class IVsUserSettingsQuery
public interface class IVsUserSettingsQuery
__interface IVsUserSettingsQuery
[System.Runtime.InteropServices.Guid("334E1F15-7D97-4231-81B0-998E4A960E69")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsUserSettingsQuery
[<System.Runtime.InteropServices.Guid("334E1F15-7D97-4231-81B0-998E4A960E69")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsUserSettingsQuery = interface
Public Interface IVsUserSettingsQuery
Abgeleitet
Attribute

Beispiele

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

Hinweise

Hinweise für Implementierer

Implementieren Sie, wenn ein VSPackage Steuern muss, ob seine Einstellungen in einer Visual Studio Einstellungsdatei gespeichert werden.

Hinweise für Aufrufer

Diese Schnittstelle sollte nur implementiert werden, wenn ein VSPackage die Einsparungen der Einstellungen steuern muss.

Beispielsweise kann ein VSPackage Benutzern gestatten, Einstellungen für die aktuelle Sitzung zu ändern, aber nur gespeicherte Informationen aktualisieren, wenn Sie auf die Schaltfläche Speichern klicken.

Wenn diese Schnittstelle von einem VSPackage nicht implementiert wird, wird der Zustand immer exportiert.

Ein einzelnes VSPackage kann mehrere benutzerdefinierte Einstellungs Punkte (Einstellungs Kategorie) unterstützen. Daher müssen Implementierungen von NeedExport das angegebene GUID-oder Einstellungs Kategorieargument des benutzerdefinierten Einstellungs Punkts überprüfen, um zu bestimmen, ob eine bestimmte Gruppe von Einstellungen gespeichert werden muss.

Beispielsweise fordert das VSPackage im folgenden Beispiel immer an, dass der Befehls leisten Zustand gespeichert wird, sondern nur, dass der Schlüssel Bindungs Zustand gespeichert wird, wenn ein Flag festgelegt wurde.

Methoden

NeedExport(String, Int32)

Gibt an, ob die angegebene Kategorie einen Export ihrer Einstellungen erfordert.

Gilt für