IVsPersistentTextImage.Image_FullTextRead Method

  • Article

Reads the full text image.

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

Syntax

'Declaration
Function Image_FullTextRead ( _
    <OutAttribute> ByRef ppszText As String, _
    <OutAttribute> ByRef piLength As Integer _
) As Integer

int Image_FullTextRead(
    out string ppszText,
    out int piLength
)

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

abstract Image_FullTextRead : 
        ppszText:string byref * 
        piLength:int byref -> int

function Image_FullTextRead(
    ppszText : String, 
    piLength : int
) : int

Parameters

  • 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:

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.

.NET Framework Security

See Also

Reference

IVsPersistentTextImage Interface

Microsoft.VisualStudio.TextManager.Interop Namespace