IVsHierarchy.GetCanonicalName(UInt32, String) Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Gibt einen eindeutigen Zeichenfolgennamen für ein Element in der Hierarchie zurück. Wird für die Arbeitsbereichspersistenz verwendet, zum Beispiel das Aufzeichnen der Fensterpositionen.
public:
int GetCanonicalName(System::UInt32 itemid, [Runtime::InteropServices::Out] System::String ^ % pbstrName);
int GetCanonicalName(unsigned int itemid, [Runtime::InteropServices::Out] std::wstring const & & pbstrName);
public int GetCanonicalName (uint itemid, out string pbstrName);
abstract member GetCanonicalName : uint32 * string -> int
Public Function GetCanonicalName (itemid As UInteger, ByRef pbstrName As String) As Integer
Parameter
- itemid
- UInt32
[in] Bezeichner des Hierarchieelements. Eine Liste der itemid-Werte finden Sie unter VSITEMID.
- pbstrName
- String
[out] Zeiger auf den kanonischen Namen des Hierarchienelements.
Gibt zurück
Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Bei einem Fehler wird ein Fehlercode zurückgegeben.
Hinweise
Eine Hierarchie ist ein Objekt, das viele Elemente enthält, aber nicht notwendigerweise ein Objekt für jedes dieser Elemente enthält. Um Informationen zu einem der Hierarchie Elemente zu erhalten, müssen Sie daher das Hierarchie Objekt nach diesen Informationen Abfragen. Der Element Bezeichner ( itemid ) wird verwendet, um das angeforderte Element in dieser Abfrage zu identifizieren. Mithilfe der GetCanonicalName -Methode übergeben Sie die Itemid, und der kanonische Name wird zurückgegeben. Der kanonische Name ist ein eindeutiger Name, der zum unterscheiden eines bestimmten Elements in der Hierarchie von allen anderen Elementen in der Hierarchie verwendet wird.
Kanonische Namen ändern sich nicht zwischen Sitzungen der Umgebung, aber Element Bezeichner. Verwenden Sie diese Methode, um die Arbeitsbereichs Persistenz zu verwalten, z. b. die Position
Hinweis
Die Umgebung ruft in der Regel diese Methode auf, aber Sie kann von jeder Person mit einem Hierarchy-Objekt und einem bestimmten Element Bezeichner aufgerufen werden.
Verwenden ParseCanonicalName Sie, um einen Element Bezeichner (Element-ID) mit dem kanonischen Namen eines Elements zu bestimmen.
COM-Signatur
Aus vsshell. idl:
HRESULT IVsHierarchy::GetCanonicalName(
[in] VSITEMID itemid,
[out] BSTR *pbstrName
);