IVsTextScanner.Read(String, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.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.

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

public:
 int Read([Runtime::InteropServices::Out] System::String ^ % ppszText, [Runtime::InteropServices::Out] int % piLength);

int Read([Runtime::InteropServices::Out] std::wstring const & & ppszText, [Runtime::InteropServices::Out] int & piLength);

public int Read (out string ppszText, out int piLength);

abstract member Read : string * int -> int

Public Function Read (ByRef ppszText As String, ByRef piLength As Integer) As Integer

Parameters

ppszText: String

[out] Range of the text buffer to read.

piLength: Int32

[out] Length of text to read from the buffer.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

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.

Applies to