Share via


IVsObjectBrowserDescription2.AddDescriptionText Method

Adds descriptive text for an object browser object.

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

Syntax

'Declaration
Function AddDescriptionText ( _
    pText As String, _
    obdSect As VSOBDESCRIPTIONSECTION, _
    pHyperJump As VSOBJECTINFO() _
) As Integer
'Usage
Dim instance As IVsObjectBrowserDescription2 
Dim pText As String 
Dim obdSect As VSOBDESCRIPTIONSECTION 
Dim pHyperJump As VSOBJECTINFO()
Dim returnValue As Integer 

returnValue = instance.AddDescriptionText(pText, _
    obdSect, pHyperJump)
int AddDescriptionText(
    string pText,
    VSOBDESCRIPTIONSECTION obdSect,
    VSOBJECTINFO[] pHyperJump
)
int AddDescriptionText(
    [InAttribute] String^ pText, 
    [InAttribute] VSOBDESCRIPTIONSECTION obdSect, 
    [InAttribute] array<VSOBJECTINFO>^ pHyperJump
)
function AddDescriptionText(
    pText : String, 
    obdSect : VSOBDESCRIPTIONSECTION, 
    pHyperJump : VSOBJECTINFO[]
) : int

Parameters

  • pText
    Type: System.String

    [in] Pointer to a string containing the 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

You can call AddDescriptionText with OBDS_ENABLEHELP and the other arguments null to enable help commands.

COM Signature

[C++]

From vsshell.idl:

HRESULT IVsObjectBrowserDescription2::AddDescriptionText(
   [in] LPCWSTR pText, 
   [in] VSOBDESCRIPTIONSECTION obdSect, 
   [in] VSOBJECTINFO *pHyperJump
);

.NET Framework Security

See Also

Reference

IVsObjectBrowserDescription2 Interface

IVsObjectBrowserDescription2 Members

Microsoft.VisualStudio.Shell.Interop Namespace