IVsNavigableLocationResolver::GetDisplayText Method (UInt32, array<TextSpan>^, IVsTextLines^, UInt32, String^)

Visual Studio 2015

Gets text to display in context menu for specified location.

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

Syntax

C++

int GetDisplayText(
	unsigned int dwReserved,
	array<TextSpan>^ ptsBase,
	IVsTextLines^ pBuffer,
	[OutAttribute] unsigned int% dwOutFlags,
	[OutAttribute] String^% pbstrDisplayText
)

Parameters

dwReserved: Type: System::UInt32
[in] Reserved. Set to zero.

ptsBase: Type: array<Microsoft.VisualStudio.TextManager.Interop::TextSpan>^
[in] Current selection or caret location.

pBuffer: Type: Microsoft.VisualStudio.TextManager.Interop::IVsTextLines^
[in] Base buffer.

dwOutFlags: Type: System::UInt32
[out] If current location is a URL.

pbstrDisplayText: Type: System::String^
[out] Text to display in context menu.

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:

C++

HRESULT IVsNavigableLocationResolver::GetDisplayText(
   [in] DWORD dwReserved,
   [in] TextSpan *ptsBase,
   [in] IVsTextLines *pBuffer,
   [out] NavigableLocationResolverFlags *dwOutFlags,
   [out,retval] BSTR * pbstrDisplayText
);