Share via


FlavoredProject.IVsUIHierarchy.ParseCanonicalName(String, UInt32) Method

Definition

Returns the identifier of the hierarchy item, given its canonical name.

 virtual int Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy.ParseCanonicalName(System::String ^ pszName, [Runtime::InteropServices::Out] System::UInt32 % pitemid) = Microsoft::VisualStudio::Shell::Interop::IVsUIHierarchy::ParseCanonicalName;
int Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy.ParseCanonicalName(std::wstring const & pszName, [Runtime::InteropServices::Out] unsigned int & pitemid);
int IVsUIHierarchy.ParseCanonicalName (string pszName, out uint pitemid);
abstract member Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy.ParseCanonicalName : string * uint32 -> int
override this.Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy.ParseCanonicalName : string * uint32 -> int
Function ParseCanonicalName (pszName As String, ByRef pitemid As UInteger) As Integer Implements IVsUIHierarchy.ParseCanonicalName

Parameters

pszName
String

The canonical name of the item.

pitemid
UInt32

[out] The ID of the item.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

Remarks

This method calls the ParseCanonicalName method, which calls the ParseCanonicalName method on the inner project.

Canonical names do not change between sessions of the environment, but item identifiers do. Use this method to manage workspace persistence, such as remembering window positions.

Applies to