FlavoredProject.IVsHierarchy.ParseCanonicalName Method

Article
04/29/2015

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

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

Syntax

'Declaration
Private Function ParseCanonicalName ( _
    name As String, _
    <OutAttribute> ByRef itemId As UInteger _
) As Integer Implements IVsHierarchy.ParseCanonicalName

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

private:
virtual int ParseCanonicalName(
    String^ name, 
    [OutAttribute] unsigned int% itemId
) sealed = IVsHierarchy::ParseCanonicalName

private abstract ParseCanonicalName : 
        name:string * 
        itemId:uint32 byref -> int  
private override ParseCanonicalName : 
        name:string * 
        itemId:uint32 byref -> int

JScript does not support explicit interface implementations.

Parameters

name
Type: String

The canonical name of the item.

itemId
Type: UInt32%

[out] The ID of the item.

Return Value

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

Implements

IVsHierarchy.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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via