Compartir a través de


IVsObjectBrowserDescription3.AddDescriptionText3 Method

Adds elements of description text to the Object Browser.

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

Syntax

'Declaración
Function AddDescriptionText3 ( _
    pText As String, _
    obdSect As VSOBDESCRIPTIONSECTION, _
    pHyperJump As IVsNavInfo _
) As Integer
'Uso
Dim instance As IVsObjectBrowserDescription3
Dim pText As String
Dim obdSect As VSOBDESCRIPTIONSECTION
Dim pHyperJump As IVsNavInfo
Dim returnValue As Integer

returnValue = instance.AddDescriptionText3(pText, _
    obdSect, pHyperJump)
int AddDescriptionText3(
    string pText,
    VSOBDESCRIPTIONSECTION obdSect,
    IVsNavInfo pHyperJump
)
int AddDescriptionText3(
    [InAttribute] String^ pText, 
    [InAttribute] VSOBDESCRIPTIONSECTION obdSect, 
    [InAttribute] IVsNavInfo^ pHyperJump
)
abstract AddDescriptionText3 : 
        pText:string * 
        obdSect:VSOBDESCRIPTIONSECTION * 
        pHyperJump:IVsNavInfo -> int 
function AddDescriptionText3(
    pText : String, 
    obdSect : VSOBDESCRIPTIONSECTION, 
    pHyperJump : IVsNavInfo
) : int

Parameters

  • pText
    Type: System.String
    [in] Pointer to the text string that contains the description text to add.

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 vsshell80.idl:

HRESULT IVsObjectBrowserDescription3::AddDescriptionText3(
   [in] LPCWSTR pText, 
   [in] VSOBDESCRIPTIONSECTION obdSect, 
   [in] IVsNavInfo *pHyperJump
);

The environment passes a pointer to this interface when it calls FillDescription on an item that the user has selected in the object browser. Make multiple calls to AddDescriptionText3 to fill in the elements of the description text displayed in the object browser description pane. Identify the elements of the description by using values from the VSOBDESCRIPTIONSECTION enumeration.

.NET Framework Security

See Also

Reference

IVsObjectBrowserDescription3 Interface

IVsObjectBrowserDescription3 Members

Microsoft.VisualStudio.Shell.Interop Namespace