VSOBSEARCHCRITERIA Structure

Article
2013-02-04

Specifies conditions and attributes of a search request.

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

Syntax

'Declaration
Public Structure VSOBSEARCHCRITERIA

public struct VSOBSEARCHCRITERIA

public value class VSOBSEARCHCRITERIA

[<Sealed>]
type VSOBSEARCHCRITERIA =  struct end

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

The VSOBSEARCHCRITERIA type exposes the following members.

Methods

	Name	Description
	Equals	Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from ValueType.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Fields

	Name	Description
	dwCustom	DWORD containing custom information.
	eSrchType	Specifies what part of an object's name is represented by szName. Values are taken from the VSOBSEARCHTYPE enumeration.
	grfOptions	Specifies limits on the object search. Values are taken from the _VSOBSEARCHOPTIONS enumeration.
	szName	String containing the name of the item to search for.

Top

Remarks

The environment's object manager requests information from object lists with calls to GetList method. A VSOBSEARCHCRITERIA parameter specifies the information that is being requested. Base the selection of information returned on these search parameters.

Examples

// If pobSrch has been set to the following values

VSOBSEARCHCRITERIA * pobSrch;

PobSrch->szName = "Train";

pobSrc->eSrchType = SO_SUBSTRING;

pobSrc->grfOptions = VSOBSO_CASESENSITIVE;

// and other parameters are

index = 2;

ListType = LLT_CLASSES;

Flags = LLF_USESEARCHFILTER;

//Then

CvsObjectList::GetList ( index, ListType, Flags, *pobSrch, **ppList);

//should return a list containing

// Train

// ToyTrain

// TrainingWheels

//but not

// train

// Strain

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