Udostępnij za pośrednictwem

Metoda IVsHierarchy.GetCanonicalName — (UInt32, String)

  • Artykuł

 

Zwraca unikatowy, nazwa ciągu dla elementu w hierarchii. Używany dla trwałości obszaru roboczego, takich jak Uzupełnij położenia okien.

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

Składnia

int GetCanonicalName(
    uint itemid,
    out string pbstrName
)

int GetCanonicalName(
    unsigned int itemid,
    [OutAttribute] String^% pbstrName
)

abstract GetCanonicalName : 
        itemid:uint32 *
        pbstrName:string byref -> int

Function GetCanonicalName (
    itemid As UInteger,
    <OutAttribute> ByRef pbstrName As String
) As Integer

Parametry

  • itemid
    Type: System.UInt32

    [in] Identyfikator elementu hierarchii. Aby uzyskać listę itemid wartości, zobacz VSITEMID.

  • pbstrName
    Type: System.String

    [out] Wskaźnik do nazwy kanonicznej elementu hierarchii.

Wartość zwracana

Type: System.Int32

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

Uwagi

Hierarchia jest obiektem, który zawiera wiele elementów, ale nie musi zawierać obiektu dla każdego z tych elementów. W związku z tym Aby uzyskać informacje o tych elementów hierarchii, należy stanu obiektu hierarchii dla tych informacji. Identyfikator elementu (itemid) służy do identyfikacji żądany element z tej kwerendy. Przy użyciu GetCanonicalName metody, podaj identyfikator elementu i nazwa kanoniczna są zwracane. Nazwa kanoniczna jest unikatową nazwą używany do odróżnienia określonego elementu w hierarchii każdy inny element w hierarchii.

Nie zmieniaj nazwy kanonicznej między sesjami środowiska, ale nie identyfikatory elementów. Ta metoda umożliwia zarządzanie trwałości obszaru roboczego, takich jak Uzupełnij położenia okien.

[!UWAGA]

Środowisko zwykle wywołuje tę metodę, ale może ona zostać wywołana przez nikogo z obiektu hierarchii i identyfikator określonego elementu.

Użyj ParseCanonicalName ustalenie, identyfikator elementu (identyfikator elementu), biorąc pod uwagę nazwa kanoniczna dla elementu.

Podpis COM

Z vsshell.idl:

HRESULT IVsHierarchy::GetCanonicalName(
   [in] VSITEMID itemid,
   [out] BSTR *pbstrName
);

Zobacz też

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

Powrót do początku