IVsOutputGroup.get_CanonicalName Method
Returns the canonical name of the output group.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function get_CanonicalName ( _
<OutAttribute> ByRef pbstrCanonicalName As String _
) As Integer
int get_CanonicalName(
out string pbstrCanonicalName
)
int get_CanonicalName(
[OutAttribute] String^% pbstrCanonicalName
)
abstract get_CanonicalName :
pbstrCanonicalName:string byref -> int
function get_CanonicalName(
pbstrCanonicalName : String
) : int
Parameters
pbstrCanonicalName
Type: String%[out] Pointer to the canonical name of the output group.
Return Value
Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
COM Signature
From vsshell.idl:
HRESULT IVsOutputGroup::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.
.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.