FlavoredProject.IVsHierarchy.GetCanonicalName Method
Gets a unique name for an item in the hierarchy. Used for workspace persistence, such as remembering window positions.
Namespace: Microsoft.VisualStudio.Shell.Flavor
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
Private Function GetCanonicalName ( _
itemId As UInteger, _
<OutAttribute> ByRef name As String _
) As Integer Implements IVsHierarchy.GetCanonicalName
int IVsHierarchy.GetCanonicalName(
uint itemId,
out string name
)
private:
virtual int GetCanonicalName(
unsigned int itemId,
[OutAttribute] String^% name
) sealed = IVsHierarchy::GetCanonicalName
private abstract GetCanonicalName :
itemId:uint32 *
name:string byref -> int
private override GetCanonicalName :
itemId:uint32 *
name:string byref -> int
JScript does not support explicit interface implementations.
Parameters
itemId
Type: UInt32The ID of the hierarchy item.
name
Type: String%[out] The canonical name 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.GetCanonicalName(UInt32, String%)
Remarks
This method calls the GetCanonicalName method, which calls the GetCanonicalName method on the inner project.
.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.