IVsObjectBrowserDescription3.AddDescriptionText3 Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds elements of description text to the Object Browser.

public:
 int AddDescriptionText3(System::String ^ pText, Microsoft::VisualStudio::Shell::Interop::VSOBDESCRIPTIONSECTION obdSect, Microsoft::VisualStudio::Shell::Interop::IVsNavInfo ^ pHyperJump);

public:
 int AddDescriptionText3(Platform::String ^ pText, Microsoft::VisualStudio::Shell::Interop::VSOBDESCRIPTIONSECTION obdSect, Microsoft::VisualStudio::Shell::Interop::IVsNavInfo ^ pHyperJump);

int AddDescriptionText3(std::wstring const & pText, Microsoft::VisualStudio::Shell::Interop::VSOBDESCRIPTIONSECTION obdSect, Microsoft::VisualStudio::Shell::Interop::IVsNavInfo const & pHyperJump);

public int AddDescriptionText3 (string pText, Microsoft.VisualStudio.Shell.Interop.VSOBDESCRIPTIONSECTION obdSect, Microsoft.VisualStudio.Shell.Interop.IVsNavInfo pHyperJump);

abstract member AddDescriptionText3 : string * Microsoft.VisualStudio.Shell.Interop.VSOBDESCRIPTIONSECTION * Microsoft.VisualStudio.Shell.Interop.IVsNavInfo -> int

Public Function AddDescriptionText3 (pText As String, obdSect As VSOBDESCRIPTIONSECTION, pHyperJump As IVsNavInfo) As Integer

Parameters

pText: String

[in] Pointer to the text string that contains the description text to add.

obdSect: VSOBDESCRIPTIONSECTION

[in] Identifies which element of the description text is to be filled in by pText. Values are taken from the VSOBDESCRIPTIONSECTION enumeration.

pHyperJump: IVsNavInfo

[in] Specifies a VSOBJECTINFO structure containing navigation information to a source file containing the referenced object.

Returns

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.

Applies to

Share via