IVsPersistentTextImage.Image_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.

Reads the full text image.

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

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

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

abstract member Image_FullTextRead : string * int -> int

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

Parameters

ppszText: String

[out] The text image.

piLength: Int32

[out] The length of the text image.

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 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.

Applies to