SearchFiles Method
Syntax
Engine.SearchFiles ( searchString, searchOptions, filterOptions, elementsToSearch, limitToAdapters, limitToNamedProps, limitToPropsOfNamedTypes, openFilesToSearch, directoriesAndFilePaths)
Return Value
A SearchResults object.
Purpose
Begin a new find in files search.
Remarks
Returns a SearchResults object that is a handle to the asynchronous search already in progress. To wait for the search to complete, call SearchResults.IsComplete.
Parameters
searchString As String
[In] Pass the string or regular expression for which to search. In order to use regular expressions, you must specify SearchOptions_RegExpr for the searchOptions parameter.
searchOptions As long
[In] Pass one or more SearchOptions constants. Use the bitwise-OR operator to specify multiple search options.
filterOptions As long
[In] Pass one or more SearchFilterOptions constants. Use the bitwise-OR operator to specify multiple search filter options.
elementsToSearch As long
[In] Pass one or more SearchElements constants. Use the bitwise-OR operator to specify multiple elements to search.
limitToAdapters As String Array
[In] Pass an array of AdapterKeyNames constants to indicate the steps of which adapters to search. Pass an empty array or NULL to search steps that use any adapter.
limitToNamedProps As String Array
[In] Pass an array of property names under which to limit the search. Pass an empty array or NULL to search all properties. If you specify names of properties to which to limit the search, TestStand only searches those properties with the names you specify and all of their subproperties.
limitToPropsOfNamedTypes As String Array
[In] Pass an array of type names to which to limit the search. Pass an empty array or NULL to search instances of all types. Use this parameter to limit the search instances of all types. Use this parameter to limit the search to instances of the types you specify.
openFilesToSearch As Object Array
[In] Pass an array of PropertyObjectFile references to specify already open files in which to search. You can pass an empty array or NULL for this parameter.
directoriesAndFilePaths As String Array
[In] Pass an array of directories and/or file paths to indicate which files to load and search. All paths must be absolute paths. If you specify a directory, TestStand searches all sequence files under that directory and any of its subdirectories. You can pass an empty array or NULL for this parameter.