IVsDropdownBarClient.GetEntryText Method

  • Article

Returns the text for a combo entry.

Namespace:  Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaration
Function GetEntryText ( _
    iCombo As Integer, _
    iIndex As Integer, _
    <OutAttribute> ByRef ppszText As String _
) As Integer

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

int GetEntryText(
    [InAttribute] int iCombo, 
    [InAttribute] int iIndex, 
    [OutAttribute] String^% ppszText
)

abstract GetEntryText : 
        iCombo:int * 
        iIndex:int * 
        ppszText:string byref -> int

function GetEntryText(
    iCombo : int, 
    iIndex : int, 
    ppszText : String
) : int

Parameters

  • iCombo
    Type: System.Int32

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

  • ppszText
    Type: System.String%

    [out] String containing the text.

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 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.

.NET Framework Security

See Also

Reference

IVsDropdownBarClient Interface

Microsoft.VisualStudio.TextManager.Interop Namespace