Share via


IVsOutput2.get_CanonicalName Method

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

'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: 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:

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.

.NET Framework Security

See Also

Reference

IVsOutput2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace