IVsObjectBrowserDescription2.AddDescriptionText Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.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 descriptive text for an object browser object.

public:
 int AddDescriptionText(System::String ^ pText, Microsoft::VisualStudio::Shell::Interop::VSOBDESCRIPTIONSECTION obdSect, cli::array <Microsoft::VisualStudio::Shell::Interop::VSOBJECTINFO> ^ pHyperJump);

int AddDescriptionText(std::wstring const & pText, Microsoft::VisualStudio::Shell::Interop::VSOBDESCRIPTIONSECTION obdSect, std::Array <Microsoft::VisualStudio::Shell::Interop::VSOBJECTINFO> const & pHyperJump);

public int AddDescriptionText (string pText, Microsoft.VisualStudio.Shell.Interop.VSOBDESCRIPTIONSECTION obdSect, Microsoft.VisualStudio.Shell.Interop.VSOBJECTINFO[] pHyperJump);

abstract member AddDescriptionText : string * Microsoft.VisualStudio.Shell.Interop.VSOBDESCRIPTIONSECTION * Microsoft.VisualStudio.Shell.Interop.VSOBJECTINFO[] -> int

Public Function AddDescriptionText (pText As String, obdSect As VSOBDESCRIPTIONSECTION, pHyperJump As VSOBJECTINFO()) As Integer

Parameters

pText: String

[in] Pointer to a string containing the text to add.

obdSect: VSOBDESCRIPTIONSECTION

[in] Value from the VSOBDESCRIPTIONSECTION enumeration indicating the type of the object or description.

pHyperJump: VSOBJECTINFO[]

[in] Pointer to a VSOBJECTINFO structure containing information about the object being described.

Returns

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

Applies to

Share via