IVsObjectBrowserDescription2::AddDescriptionText Method (String^, VSOBDESCRIPTIONSECTION, array<VSOBJECTINFO>^)

Visual Studio 2015

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

C++

int AddDescriptionText(
	String^ pText,
	VSOBDESCRIPTIONSECTION obdSect,
	array<VSOBJECTINFO>^ pHyperJump
)

Parameters

pText: Type: System::String^
[in] Pointer to a string containing the text to add.

obdSect: Type: Microsoft.VisualStudio.Shell.Interop::VSOBDESCRIPTIONSECTION
[in] Value from the VSOBDESCRIPTIONSECTION enumeration indicating the type of the object or description.

pHyperJump: Type: array<Microsoft.VisualStudio.Shell.Interop::VSOBJECTINFO>^
[in] Pointer to a VSOBJECTINFO structure containing information about the object being described.

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
);