FlavoredProject::IVsUIHierarchy::ParseCanonicalName Method (String^, UInt32)

Visual Studio 2015

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

Namespace: Microsoft.VisualStudio.Shell.Flavor
Assembly: Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

Syntax

C++

private:
virtual int ParseCanonicalName(
	String^ pszName,
	[OutAttribute] unsigned int% pitemid
) sealed = IVsUIHierarchy::ParseCanonicalName

Parameters

pszName: Type: System::String^
The canonical name of the item.

pitemid: Type: System::UInt32
[out] The ID of the item.

Return Value

Type: System::Int32

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

Implements

IVsUIHierarchy::ParseCanonicalName(String^, UInt32)

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.