ViewFilter.GetWordExtent(Int32, Int32, UInt32, TextSpan[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the result of Source.GetWordExtent.

public:
 virtual int GetWordExtent(int line, int index, System::UInt32 flags, cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ span);

public:
 virtual int GetWordExtent(int line, int index, unsigned int flags, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ span);

 virtual int GetWordExtent(int line, int index, unsigned int flags, std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & span);

public virtual int GetWordExtent (int line, int index, uint flags, Microsoft.VisualStudio.TextManager.Interop.TextSpan[] span);

abstract member GetWordExtent : int * int * uint32 * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] -> int
override this.GetWordExtent : int * int * uint32 * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] -> int

Public Overridable Function GetWordExtent (line As Integer, index As Integer, flags As UInteger, span As TextSpan()) As Integer

Parameters

line: Int32

[in] The line number to examine.

index: Int32

[in] The character offset on the line to examine.

flags: UInt32

[in] A combination of flags from the WORDEXTFLAGS enumeration.

span: TextSpan[]

[out] Returns a TextSpan object that contains the requested span.

Returns

Int32

If successful, returns S_OK. Returns S_FALSE if there is no identifier or expression at the specified location; otherwise, returns an error code.

Implements

GetWordExtent(Int32, Int32, UInt32, TextSpan[])

Remarks

This method is called to get the extent of an identifier or an expression starting at a specific location. The location can be in the middle or at the end of the identifier or expression.

This method is an implementation of the GetWordExtent method on the IVsTextViewFilter interface.

The base method validates the parameters and forwards the call to the GetWordExtent on the Source object that was obtained in the ViewFilter constructor.

Applies to