IVsTextScanner::Read Method (String^, Int32)

Visual Studio 2015

Performs a scan of the text buffer, or portion of the text buffer defined by the string length, piLength.

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

Syntax

C++

int Read(
	[OutAttribute] String^% ppszText,
	[OutAttribute] int% piLength
)

Parameters

ppszText: Type: System::String^
[out] Range of the text buffer to read.

piLength: Type: System::Int32
[out] Length of text to read from the buffer.

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 IVsTextScanner::Read(
   [out] WCHAR **ppszText,
   [out] long *piLength
);

The parameter piLength is an integer value for the length of text pointed to by ppszText. If the value is zero, there is no more text.

Note
The text buffer is created by the IVsTextScanner object and the buffer must persist for the life of the IVsTextScanner object or until the CloseScan method is called.