IVsFullTextScanner.FullTextRead Method
Performs the actual scan.
Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)
Syntax
'Declaración
Function FullTextRead ( _
<OutAttribute> ByRef ppszText As String, _
<OutAttribute> ByRef piLength As Integer _
) As Integer
'Uso
Dim instance As IVsFullTextScanner
Dim ppszText As String
Dim piLength As Integer
Dim returnValue As Integer
returnValue = instance.FullTextRead(ppszText, _
piLength)
int FullTextRead(
out string ppszText,
out int piLength
)
int FullTextRead(
[OutAttribute] String^% ppszText,
[OutAttribute] int% piLength
)
abstract FullTextRead :
ppszText:string byref *
piLength:int byref -> int
function FullTextRead(
ppszText : String,
piLength : int
) : int
Parameters
- ppszText
Type: System.String%
[out] Pointer to the contents of the text buffer.
- piLength
Type: System.Int32%
[out] Length of text pointed to by *ppszText.
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 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.
Nota
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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.