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)
Syntax
'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("EBD73923-C190-45C1-91C5-0BC61A8AAB14")> _
Public Interface IVsTextScanner
[InterfaceTypeAttribute()]
[GuidAttribute("EBD73923-C190-45C1-91C5-0BC61A8AAB14")]
public interface IVsTextScanner
[InterfaceTypeAttribute()]
[GuidAttribute(L"EBD73923-C190-45C1-91C5-0BC61A8AAB14")]
public interface class IVsTextScanner
[<InterfaceTypeAttribute()>]
[<GuidAttribute("EBD73923-C190-45C1-91C5-0BC61A8AAB14")>]
type IVsTextScanner = interface end
public interface IVsTextScanner
The IVsTextScanner type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
CloseScan | Closes the buffer for scanning and re-enables writing to the buffer. |
|
OpenScan | Opens the text buffer for scanning. |
|
Read | Performs a scan of the text buffer, or portion of the text buffer defined by the string length, piLength. |
Top
Remarks
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.