IVsOutputGroup2::get_CanonicalName Method (String^)

Visual Studio 2015

Returns the canonical name of the output group.

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

Syntax

C++

int get_CanonicalName(
	[OutAttribute] String^% pbstrCanonicalName
)

Parameters

pbstrCanonicalName: Type: System::String^
[out] Pointer to the canonical name of the output group.

Return Value

Type: System::Int32

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

Implements

IVsOutputGroup::get_CanonicalName(String^)

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsOutputGroup2::get_CanonicalName(

[out] BSTR *pbstrCanonicalName

);

Canonical group names are Unicode, since typically they are passed as LPCOLESTR arguments to COM methods. They must not be localized. Canonical names should be predictable so that project A, for example, can ask project B for its build outputs and have a reasonable expectation as to what it will be getting.

This method returns the same information regardless of the project's configuration settings. Using canonical names allows projects to ask for specific types of outputs, such as source files or documentation. Users do not see canonical names; they see only display names.