Share via


IVsTextView.GetWordExtent Method

Returns the current word extent.

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

Syntax

'Declaration
Function GetWordExtent ( _
    iLine As Integer, _
    iCol As Integer, _
    dwFlags As UInteger, _
    <OutAttribute> pSpan As TextSpan() _
) As Integer
int GetWordExtent(
    int iLine,
    int iCol,
    uint dwFlags,
    TextSpan[] pSpan
)
int GetWordExtent(
    [InAttribute] int iLine, 
    [InAttribute] int iCol, 
    [InAttribute] unsigned int dwFlags, 
    [OutAttribute] array<TextSpan>^ pSpan
)
abstract GetWordExtent : 
        iLine:int * 
        iCol:int * 
        dwFlags:uint32 * 
        pSpan:TextSpan[] byref -> int 
function GetWordExtent(
    iLine : int, 
    iCol : int, 
    dwFlags : uint, 
    pSpan : TextSpan[]
) : int

Parameters

  • iLine
    Type: System.Int32
    [in] Line index for the lines that contains the word.
  • dwFlags
    Type: System.UInt32
    [in] Flags specifying how the word extent is determined. For a list of dwFlags values, see WORDEXTFLAGS.

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

.NET Framework Security

See Also

Reference

IVsTextView Interface

Microsoft.VisualStudio.TextManager.Interop Namespace