IVsPersistentTextImage::Image_FullTextRead Method (String^, Int32)

Visual Studio 2015

Reads the full text image.

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

Syntax

C++

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

Parameters

ppszText: Type: System::String^
[out] The text image.

piLength: Type: System::Int32
[out] The length of the text image.

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

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

Note

The text buffer is created by the IVsPersistentTextImage object and the buffer must persist for the life of the IVsPersistentTextImage object or until the Image_CloseFullTextScan method is called.

If you are implementing this interface in managed code and you need to have the string disposed of by the caller, implement the IVsCoTaskMemFreeMyStrings interface on the IVsPersistentTextImage interface.