This topic has not yet been rated - Rate this topic

IVsTextScanner Interface

A special-purpose interface exposed by text buffers and used to provide fast, stream-oriented, sequential access to the text in the buffer.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in microsoft.visualstudio.textmanager.interop.dll)

[InterfaceTypeAttribute(1)] 
[GuidAttribute("EBD73923-C190-45C1-91C5-0BC61A8AAB14")] 
public interface IVsTextScanner
/** @attribute InterfaceTypeAttribute(1) */ 
/** @attribute GuidAttribute("EBD73923-C190-45C1-91C5-0BC61A8AAB14") */ 
public interface IVsTextScanner
InterfaceTypeAttribute(1) 
GuidAttribute("EBD73923-C190-45C1-91C5-0BC61A8AAB14") 
public interface IVsTextScanner

IVsTextScanner is particularly useful to compilers, which need rapid, sequential, stream-oriented access to text in the text buffer. However, this interface locks the buffer and performs a garbage-collection pass, which incurs an expensive performance hit. Use of this interface is therefore not recommended in scenarios such as performing a query status on the handler or other performance-sensitive scenarios.

This interface allows you to obtain selected text from the text buffer. If you need access to the full contents of the text buffer, consider using IVsFullTextScanner.

Notes to Implementers Implement IVsTextScanner to obtain quick access to the text buffer.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ