IVsDropdownBarClient.GetEntryText(Int32, Int32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Returns the text for a combo entry.

public:
 int GetEntryText(int iCombo, int iIndex, [Runtime::InteropServices::Out] System::String ^ % ppszText);

int GetEntryText(int iCombo, int iIndex, [Runtime::InteropServices::Out] std::wstring const & & ppszText);

public int GetEntryText (int iCombo, int iIndex, out string ppszText);

abstract member GetEntryText : int * int * string -> int

Public Function GetEntryText (iCombo As Integer, iIndex As Integer, ByRef ppszText As String) As Integer

Parameters

iCombo: Int32

[in] The drop-down bar/Window combo.

iIndex: Int32

[in] Index of item of interest.

ppszText: String

[out] String containing the text.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsDropdownBarClient::GetEntryText(  
   [in] long iCombo,  
   [in] long iIndex,  
   [out] WCHAR **ppszText  
);

Note

The text buffer returned in ppszText is typically created by the IVsDropdownBarClient object and the buffer must persist for the life of the IVsDropdownBarClient object.

If you are implementing this interface in managed code and you need to have the string disposed of by the caller, implement the IVsCoTaskMemFreeMyStrings interface on the IVsDropdownBarClient interface.

Applies to