IVsOutput::get_CanonicalName Method (String^)

Visual Studio 2015

Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Visual Studio 2005

Returns the canonical name of an output item.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int get_CanonicalName(
	[OutAttribute] String^% pbstrCanonicalName
)

Parameters

pbstrCanonicalName: Type: System::String^
[out] Pointer to the output item's canonical name.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsOutput::get_CanonicalName(
   [out] BSTR *pbstrCanonicalName
);

An output item's canonical name must be unique within the project configuration. It need not be based on the display name. Once set, the canonical name never changes, even if other attributes of the item change.