Udostępnij za pośrednictwem

Metoda IVsUIHierarchy.GetCanonicalName — (UInt32, String)

  • Artykuł

 

Stosowany do trwałości obszaru roboczego, na przykład zapamiętywanie pozycji okna.

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
    [w] Identyfikator elementu hierarchii.Aby uzyskać listę itemid wartości, zobacz VSITEMID.
  • pbstrName
    [out] Wskaźnik kanoniczną nazwę elementu hierarchii.

Wartość zwracana

Type: System.Int32

Jeśli metoda się powiedzie, zwraca S_OK.Jeśli nie powiedzie się, zwraca kod błędu.

Implementuje

IVsHierarchy.GetCanonicalName(UInt32, String)

Uwagi

Podpis COM

Z vsshell.idl:

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

Hierarchia jest obiekt, który zawiera wiele elementów, ale nie muszą koniecznie zawierać obiektu dla każdego z tych elementów.W ten sposób aby uzyskać informacje o hierarchii elementów, trzeba stanu obiektu hierarchii dla tych informacji.Identyfikator elementu (nr przedmiotu) jest używany do identyfikowania żądanego elementu w tej kwerendy.Za pomocą GetCanonicalName metodę, przekazywać w nr przedmiotu i zwracana jest nazwa kanoniczna.Kanoniczna nazwa jest unikatowa nazwa używana do rozróżniania określonego elementu w hierarchii z każdego elementu w hierarchii.

Nazwy kanoniczne, nie należy zmieniać między sesjami środowiska, ale działają identyfikatory zapasu.Ta metoda umożliwia zarządzanie trwałości obszaru roboczego, takie jak zapamiętywanie pozycji okna.

[!UWAGA]

Środowiska zwykle wywołuje tę metodę, ale może być wywoływana przez każdego, kto ma obiekt hierarchii i identyfikator określonego towaru.

Użyj ParseCanonicalName do określenia identyfikator przedmiotu (identyfikator elementu), podana nazwa kanoniczna dla elementu.

Zobacz też

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

Powrót do początku