IVsNavigableLocationResolver.GetDisplayText Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets text to display in context menu for specified location.

public:
 int GetDisplayText(System::UInt32 dwReserved, cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ ptsBase, Microsoft::VisualStudio::TextManager::Interop::IVsTextLines ^ pBuffer, [Runtime::InteropServices::Out] System::UInt32 % dwOutFlags, [Runtime::InteropServices::Out] System::String ^ % pbstrDisplayText);

int GetDisplayText(unsigned int dwReserved, std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & ptsBase, Microsoft::VisualStudio::TextManager::Interop::IVsTextLines const & pBuffer, [Runtime::InteropServices::Out] unsigned int & dwOutFlags, [Runtime::InteropServices::Out] std::wstring const & & pbstrDisplayText);

public int GetDisplayText (uint dwReserved, Microsoft.VisualStudio.TextManager.Interop.TextSpan[] ptsBase, Microsoft.VisualStudio.TextManager.Interop.IVsTextLines pBuffer, out uint dwOutFlags, out string pbstrDisplayText);

abstract member GetDisplayText : uint32 * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] * Microsoft.VisualStudio.TextManager.Interop.IVsTextLines * uint32 * string -> int

Public Function GetDisplayText (dwReserved As UInteger, ptsBase As TextSpan(), pBuffer As IVsTextLines, ByRef dwOutFlags As UInteger, ByRef pbstrDisplayText As String) As Integer

Parameters

dwReserved

UInt32

[in] Reserved. Set to zero.

ptsBase

TextSpan[]

[in] Current selection or caret location.

pBuffer

IVsTextLines

[in] Base buffer.

dwOutFlags

UInt32

[out] If current location is a URL.

pbstrDisplayText

String

[out] Text to display in context menu.

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 IVsNavigableLocationResolver::GetDisplayText(  
   [in] DWORD dwReserved,  
   [in] TextSpan *ptsBase,  
   [in] IVsTextLines *pBuffer,  
   [out] NavigableLocationResolverFlags *dwOutFlags,  
   [out,retval] BSTR * pbstrDisplayText  
);