IVsOutput2::get_CanonicalName Method (String^)

Visual Studio 2015

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.

Implements

IVsOutput::get_CanonicalName(String^)

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsOutput2::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.