IVsTextFind.Find Method

Article
11/19/2013

Finds a given block of text in the text buffer.

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

Syntax

'Declaration
Function Find ( _
    pszText As String, _
    iStartLine As Integer, _
    iStartIndex As Integer, _
    iEndLine As Integer, _
    iEndIndex As Integer, _
    iFlags As Integer, _
    <OutAttribute> ByRef piLine As Integer, _
    <OutAttribute> ByRef piCol As Integer _
) As Integer

int Find(
    string pszText,
    int iStartLine,
    int iStartIndex,
    int iEndLine,
    int iEndIndex,
    int iFlags,
    out int piLine,
    out int piCol
)

int Find(
    [InAttribute] String^ pszText, 
    [InAttribute] int iStartLine, 
    [InAttribute] int iStartIndex, 
    [InAttribute] int iEndLine, 
    [InAttribute] int iEndIndex, 
    [InAttribute] int iFlags, 
    [OutAttribute] int% piLine, 
    [OutAttribute] int% piCol
)

abstract Find : 
        pszText:string * 
        iStartLine:int * 
        iStartIndex:int * 
        iEndLine:int * 
        iEndIndex:int * 
        iFlags:int * 
        piLine:int byref * 
        piCol:int byref -> int

function Find(
    pszText : String, 
    iStartLine : int, 
    iStartIndex : int, 
    iEndLine : int, 
    iEndIndex : int, 
    iFlags : int, 
    piLine : int, 
    piCol : int
) : int

Parameters

pszText
Type: System.String

[in] Pointer to a null terminated string containing the text.

iStartLine
Type: System.Int32

[in] Integer containing the start line.

iStartIndex
Type: System.Int32

[in] Integer index value for the starting character within the line. Must be less than or equal to the length of line.)

iEndLine
Type: System.Int32

[in] Integer value for the end of the line.

iEndIndex
Type: System.Int32

[in] Integer index value for the ending character in the line. Must be less than or equal to the length of the line.)

iFlags
Type: System.Int32

[in] Flags from the TextFindMode enumeration.

piLine
Type: System.Int32%

[out] Pointer to the line number where the desired text is located.

piCol
Type: System.Int32%

[out] Pointer to the column number on the line where the desired text is located.

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 IVsTextFind::Find(
   [in] const WCHAR *pszText, 
   [in] long iStartLine, 
   [in] CharIndex iStartIndex, 
   [in] long iEndLine, 
   [in] CharIndex iEndIndex, 
   [in] long iFlags, 
   [out] long *piLine, 
   [out] long *piCol
);

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

Share via