Article
02/09/2012

PlanGuideCollection Class

Collection of plan guide objects.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
        Microsoft.SqlServer.Management.Smo.SimpleObjectCollectionBase
          Microsoft.SqlServer.Management.Smo.PlanGuideCollection

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class PlanGuideCollection _
    Inherits SimpleObjectCollectionBase
'Usage
Dim instance As PlanGuideCollection

public sealed class PlanGuideCollection : SimpleObjectCollectionBase

public ref class PlanGuideCollection sealed : public SimpleObjectCollectionBase

[<SealedAttribute>]
type PlanGuideCollection =  
    class
        inherit SimpleObjectCollectionBase
    end

public final class PlanGuideCollection extends SimpleObjectCollectionBase

The PlanGuideCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
	IsSynchronized	Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
	Item[Int32]	Returns an item from a collection of plan guide objects that are identified by the integer ID index of the item.
	Item[String]	Returns an Item from a collection of plan guide objects identified by the Name property of the item.
	Parent	Returns a database object that represents the parent of the collection.
	SyncRoot	Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Methods

	Name	Description
	Add	Adds a plan guide object to the collection.
	AddExisting	Adds an object to the collection. (Inherited from AbstractCollectionBase.)
	AddImpl	Adds the specified object to this collection (Inherited from SortedListCollectionBase.)
	Contains	Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
	CopyTo	Copies all the items from a plan guide collection to a compatible one-dimensional array of objects, starting at the specified index in the target array.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetCollectionElementType	Gets the Collection Element Type. (Inherited from SmoCollectionBase.)
	GetEnumerator	Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
	GetHashCode	(Inherited from Object.)
	GetItemById(Int32)	Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
	GetItemById(Int32, String)	Extracts a member from the referenced collection using a system-defined, unique identifier and name. (Inherited from SmoCollectionBase.)
	GetObjectByIndex	Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
	GetType	(Inherited from Object.)
	ImplAddExisting	Adds an existing specified object to this collection (Inherited from SortedListCollectionBase.)
	InitializeChildCollection()	Initializes the child collections of the referenced collection. (Inherited from SmoCollectionBase.)
	InitializeChildCollection(Boolean)	Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection. (Inherited from SmoCollectionBase.)
	InitInnerCollection	Initializes the collection. (Inherited from SimpleObjectCollectionBase.)
	ItemById	Returns a plan guide object as indicated by the ID property of that plan guide.
	MemberwiseClone	(Inherited from Object.)
	Refresh()	Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
	Refresh(Boolean)	Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
	Remove(String)	Removes a plan guide from a plan guide collection based on the PlanGuide Name property.
	Remove(PlanGuide)	Removes a plan guide from a plan guide collection.
	ToString	(Inherited from Object.)
	ValidateParentObject	Validates the parent object exists. (Inherited from SmoCollectionBase.)

Top

Fields

	Name	Description
	initialized	This value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.)

Top

Explicit Interface Implementations

	Name	Description
	ICollection.CopyTo	Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top

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