IVsTextView::GetWordExtent Method (Int32, Int32, UInt32, array<TextSpan>^)

Visual Studio 2015

Returns the current word extent.

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

Syntax

C++

int GetWordExtent(
	int iLine,
	int iCol,
	unsigned int dwFlags,
	array<TextSpan>^ pSpan
)

Parameters

iLine: Type: System::Int32
[in] Line index for the lines that contains the word.

iCol: Type: System::Int32
[in] Column index for the word.

dwFlags: Type: System::UInt32
[in] Flags specifying how the word extent is determined. For a list of dwFlags values, see WORDEXTFLAGS.

pSpan: Type: array<Microsoft.VisualStudio.TextManager.Interop::TextSpan>^
[out] Span of text identifying the word extent.

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 IVsTextView::GetWordExtent(
   [in] long iLine,
   [in] CharIndex iCol,
   [in] DWORD dwFlags,
   [out] TextSpan *pSpan
);

The word extent is wherever the editor determines the word boundary to be. For example, if you place your cursor in within a word and then double-click, the core text editor assumes that the word extent is that entire word.