Metoda IVsUserContext.GetAttribute — (Int32, String, Int32, String, String)

Artykuł
08/06/2016

Zwraca wartość określonego atrybutu lub słowa kluczowego ze zbioru kontekstu lub kontekst podrzędny na podstawie pozycji indeksu lub nazwy.

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

Składnia

int GetAttribute(
    int iAttribute,
    string pszName,
    int fIncludeChildren,
    out string pbstrName,
    out string pbstrValue
)

int GetAttribute(
    int iAttribute,
    String^ pszName,
    int fIncludeChildren,
    [OutAttribute] String^% pbstrName,
    [OutAttribute] String^% pbstrValue
)

abstract GetAttribute : 
        iAttribute:int *
        pszName:string *
        fIncludeChildren:int *
        pbstrName:string byref *
        pbstrValue:string byref -> int

Function GetAttribute (
    iAttribute As Integer,
    pszName As String,
    fIncludeChildren As Integer,
    <OutAttribute> ByRef pbstrName As String,
    <OutAttribute> ByRef pbstrValue As String
) As Integer

Parametry

iAttribute
Type: System.Int32

[in] Indeks kolekcji atrybutów i słów kluczowych w zbiorze kontekstu lub kontekst podrzędny.

pszName
Type: System.String

[in] Nazwa atrybutu lub słowo kluczowe. Określ nazwę atrybutu, aby uzyskać dostęp do określonego atrybutu. Określ "słowo kluczowe" Aby uzyskać dostęp do F1 lub słowo kluczowe wyszukiwania.

fIncludeChildren
Type: System.Int32

[in] Jeśli true, następnie zwracane są również zbiory kontekst podrzędny skojarzone z zbioru kontekstu. Jeśli false, a następnie kontekst podrzędny jest wyłączona.

pbstrName
Type: System.String

[out] Wskaźnik do nazwy określonego atrybutu lub słowa kluczowego wartość, jeśli zostanie znalezione dopasowanie.

pbstrValue
Type: System.String

[out, retval] Wskaźnik do wartości określonego atrybutu lub słowa kluczowego tekstu, jeśli zostanie znalezione dopasowanie.

Wartość zwracana

Type: System.Int32

Jeśli metoda zakończy się pomyślnie, zwraca S_OK. Jeśli nie, zwraca kod błędu.

Uwagi

Podpis COM

Z context.idl:

HRESULT IVsUserContext::GetAttribute(
   [in] int iAttribute,
   [in] LPCOLESTR pszName,
   [in] BOOL fIncludeChildren,
   [out] BSTR * pbstrName,
   [out, retval] BSTR * pbstrValue
);

Istnieją trzy sposoby używania IVsUserContext.GetAttribute metody:

Podawać null dla wartości pszName parametru i iterację wszystkich atrybutów i słów kluczowych w kontekście zbioru przy użyciu iAttribute parametru. Można określić liczbę atrybutów i słów kluczowych w kontekście lub kontekst podrzędny wielozbiorów przy użyciu CountAttributes metody.
Iterowanie wszystkich atrybutów i słów kluczowych i podaj nazwę określonego atrybutu lub słowa kluczowego dla wartości pszName parametru. Nazwa atrybutu i wartości lub słowa kluczowego oraz wartości są zwracane w pbstrName i pbstrValue Parametry, odpowiednio, tylko jeśli podana nazwa pasuje do nazwy w zbiorze kontekstu lub kontekst podrzędny.
Podaj wartość -1 dla iAttribute parametr i nazwę określonego atrybutu lub słowa kluczowego dla wartości pszName parametru. Pierwszy atrybutu lub słowa kluczowego, który pasuje do nazwy jest zwracana.

Jeśli ta metoda znajdzie dopasowania do pszName zwraca parametr, a następnie go S_OK. Jeśli metoda nie znajdzie dopasowania, a następnie zwraca E_UNEXPECTED. W związku z tym użytkownik może ustawić wartości *pbstrName i *pbstrValue Parametry null i ocena powodzenie lub Niepowodzenie metody opartej na zwracane wartości.

Użyj GetAttributePri metodę dostępu do atrybutów lub słowa kluczowe na podstawie ich priorytetu. Aby uzyskać więcej informacji o priorytecie, zobacz VSUSERCONTEXTPRIORITY. Użyj GetAttrUsage można określić, czy słowa kluczowego zwracane z IVsUserContext::GetAttribute jest metoda F1 lub słowo kluczowe wyszukiwania.

Wartość fIncludeChildren parametru nie obowiązuje, jeśli zbiór kontekstu nie ma żadnych kontekst podrzędny.

Zobacz też

Interfejs IVsUserContext
Przestrzeń nazw Microsoft.VisualStudio.Shell.Interop

Powrót do początku

Udostępnij za pośrednictwem