FlavoredProject.IVsHierarchy.ParseCanonicalName(String, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Flavor

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

 virtual int Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.ParseCanonicalName(System::String ^ name, [Runtime::InteropServices::Out] System::UInt32 % itemId) = Microsoft::VisualStudio::Shell::Interop::IVsHierarchy::ParseCanonicalName;

int Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.ParseCanonicalName(std::wstring const & name, [Runtime::InteropServices::Out] unsigned int & itemId);

int IVsHierarchy.ParseCanonicalName (string name, out uint itemId);

abstract member Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.ParseCanonicalName : string * uint32 -> int
override this.Microsoft.VisualStudio.Shell.Interop.IVsHierarchy.ParseCanonicalName : string * uint32 -> int

Function ParseCanonicalName (name As String, ByRef itemId As UInteger) As Integer Implements IVsHierarchy.ParseCanonicalName

Parameters

name: String

The canonical name of the item.

itemId: UInt32

[out] The ID of the item.

Returns

Int32

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

Implements

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.

Applies to

Share via