IVsObjectBrowserDescription3.AddDescriptionText3 Method

Article
02/04/2013

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

'Declaration
Function AddDescriptionText3 ( _
    pText As String, _
    obdSect As VSOBDESCRIPTIONSECTION, _
    pHyperJump As IVsNavInfo _
) As Integer

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.

obdSect
Type: Microsoft.VisualStudio.Shell.Interop.VSOBDESCRIPTIONSECTION
[in] Identifies which element of the description text is to be filled in by pText. Values are taken from the VSOBDESCRIPTIONSECTION enumeration.

pHyperJump
Type: Microsoft.VisualStudio.Shell.Interop.IVsNavInfo
[in] Specifies a VSOBJECTINFO structure containing navigation information to a source file containing the referenced object.

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

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.