IncrementalSearchResult Structure

Article
03/12/2015

Consolidates the result of an incremental search operation.

Namespace: Microsoft.VisualStudio.Text.IncrementalSearch
Assembly: Microsoft.VisualStudio.Text.UI (in Microsoft.VisualStudio.Text.UI.dll)

Syntax

'Declaration
Public Structure IncrementalSearchResult

public struct IncrementalSearchResult

public value class IncrementalSearchResult

[<Sealed>]
type IncrementalSearchResult =  struct end

JScript supports the use of structures, but not the declaration of new ones.

The IncrementalSearchResult type exposes the following members.

Constructors

	Name	Description
	IncrementalSearchResult	Initializes a new instance of IncrementalSearchResult with the specified properties.

Top

Properties

	Name	Description
	PassedEndOfBuffer	Determines whether the search wrapped around the end of the buffer to its beginning.
	PassedStartOfBuffer	Determines whether the search wrapped around the start of the buffer to its end.
	PassedStartOfSearch	Determines whether the search passed the first item found.
	ResultFound	Determines whether the search for the term was successful.

Top

Methods

	Name	Description
	Equals	Determines whether the contents of two IncrementalSearchResult objects are the same. (Overrides ValueType.Equals(Object).)
	GetHashCode	Gets the hash code for the object. (Overrides ValueType.GetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Operators

	Name	Description
	Equality	Determines whether the contents of two IncrementalSearchResult objects are the same.
	Inequality	Determines whether the contents of two IncrementalSearchResult objects are different.

Top

Remarks

This result indicates whether the item was found, whether the search caused the cursor to wrap around the beginning or end of the buffer, and the position of the first result.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via