IVsObjectBrowserDescription3::AddDescriptionText3 Method (String^, VSOBDESCRIPTIONSECTION, IVsNavInfo^)

Visual Studio 2015

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

C++

int AddDescriptionText3(
	String^ pText,
	VSOBDESCRIPTIONSECTION obdSect,
	IVsNavInfo^ pHyperJump
)

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:

C++

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.