Sdílet prostřednictvím


IVsHierarchy.GetCanonicalName – metoda (UInt32, String)

 

Vrátí jedinečný, řetězec názvu položky v hierarchii.Používá se pro perzistence prostoru, jako je například zapamatování pozice okna.

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

Syntaxe

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
    [v] Identifikátor položky hierarchie.Seznam itemid hodnoty, viz VSITEMID.
  • pbstrName
    [výstup] Ukazatel myši na položku hierarchie kanonický název.

Vrácená hodnota

Type: System.Int32

Pokud metoda uspěje, vrací S_OK.Pokud se nezdaří, vrátí kód chyby.

Poznámky

Hierarchie je objekt, který obsahuje mnoho položek, ale nemusí nutně obsahovat objekt pro každou z těchto položek.Proto chcete-li získat informace o hierarchii položek musíte dotaz na objekt hierarchie dané informace.Identifikátor zboží (itemid) se používá k identifikaci požadovanou položku v dotazu.Použití GetCanonicalName metoda, předáte ID tématu a kanonický název, bude vrácena.Kanonický název je jedinečný název používaný k určité položky v hierarchii odlišit od každé jiné položky v hierarchii.

Kanonické názvy neměňte mezi relacemi prostředí, ale identifikátory položky učinit.Tuto metodu lze použijte ke správě prostoru perzistencí, jako je například zapamatování pozice okna.

[!POZNÁMKA]

Prostředí obvykle volání této metody však lze volat kdokoli s objekt hierarchie a identifikátor určitého zboží.

Použití ParseCanonicalName určit identifikátor (ID položky) zboží uvedené normativní název pro položku.

Podpis COM

Z vsshell.idl:

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

Viz také

IVsHierarchy – rozhraní
Microsoft.VisualStudio.Shell.Interop – obor názvů

Zpátky na začátek