IVsFullTextScanner.FullTextRead(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 the actual scan.

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

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

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

abstract member FullTextRead : string * int -> int

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

Parameters

ppszText: String

[out] Pointer to the contents of the text buffer.

piLength: Int32

[out] Length of text pointed to by *ppszText.

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

A pointer to a text buffer is returned in ppszText parameter. The piLength parameter is then filled with the length of the buffer pointed to by *ppsztext.

Note

The text buffer is created by the IVsFullTextScanner object and the buffer must persist for the life of the IVsFullTextScanner object or until the CloseFullTextScan method is called. If you are implementing this interface in managed code and you need the caller to dispose of the string, implement the IVsCoTaskMemFreeMyStrings interface on the IVsFullTextScanner interface.

Applies to