This documentation is archived and is not being maintained.

Execute Method

Visual Studio .NET 2003

Performs a search based on the options set for the Find Object.

[Visual Basic .NET]
Public Function Execute() As vsFindResult
[Visual Basic 6]
Function Execute() As vsFindResult
[C++]
HRESULT __stdcall Execute(
   /* [out, retval] */ vsFindResult* retVal
);
[C#]
public vsFindResult Execute();
[JScript .NET]
public function Execute() : vsFindResult

Return Value

Returns a vsFindResult constant.

Remarks

If the search operation is asynchronous, such as Find All, then the FindDone Event occurs when the operation completes. It does not occur with any other Find or Replace operation as Find All is the only asynchronous Find operation.

Example

Sub ExecuteExample()
   Dim objTextDoc As TextDocument
   Dim objEditPt As EditPoint
   Dim iCtr As Integer
   Dim objFind As Find

   ' Create a new text file.
   DTE.ItemOperations.NewFile("General\Text File")

   ' Get a handle to the new document and create an EditPoint.
   objTextDoc = DTE.ActiveDocument.Object("TextDocument")
   objEditPt = objTextDoc.StartPoint.CreateEditPoint
   objFind = objTextDoc.DTE.Find

   ' Insert ten lines of text.
   For iCtr = 1 To 10
      objEditPt.Insert("This is a test." & Chr(13))
   Next iCtr

   ' Set the find options.
   objFind.Action = vsFindAction.vsFindActionReplaceAll
   objFind.Backwards = False
   objFind.FilesOfType = "*.txt"
   objFind.FindWhat = "test"
   objFind.KeepModifiedDocumentsOpen = True
   objFind.MatchCase = False
   objFind.MatchInHiddenText = False
   objFind.MatchWholeWord = True
   objFind.PatternSyntax = vsFindPatternSyntax.vsFindPatternSyntaxLiteral
   objFind.ReplaceWith = "NEW THING"
   objFind.ResultsLocation = vsFindResultsLocation.vsFindResultsNone
   objFind.SearchPath = "c:\temp"
   objFind.SearchSubfolders = False
   objFind.Target = vsFindTarget.vsFindTargetCurrentDocument
   ' Perform the Find operation.
   objFind.Execute()
End Sub

See Also

FindReplace Method

Applies To: Find Object

Show: