PlanGuideCollection Class

Collection of plan guide objects.

Inheritance Hierarchy


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


Public NotInheritable Class PlanGuideCollection _
    Inherits SimpleObjectCollectionBase
Dim instance As PlanGuideCollection
public sealed class PlanGuideCollection : SimpleObjectCollectionBase
public ref class PlanGuideCollection sealed : public SimpleObjectCollectionBase
type PlanGuideCollection =  
        inherit SimpleObjectCollectionBase 
public final class PlanGuideCollection extends SimpleObjectCollectionBase

The PlanGuideCollection type exposes the following members.


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



  Name Description
Public method Add Adds a plan guide object to the collection.
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Public method Contains Verifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
Public method 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.
Public method Equals (Inherited from Object.)
Public method GetEnumerator Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ItemById Returns a plan guide object as indicated by the identifier of that plan guide.
Public method Refresh() Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public method Refresh(Boolean) Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public method Remove(String) Removes a plan guide from a plan guide collection based on the PlanGuide Name property.
Public method Remove(PlanGuide) Removes a plan guide from a plan guide collection.
Public method ToString (Inherited from Object.)



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


Explicit Interface Implementations

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


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.

See Also


Microsoft.SqlServer.Management.Smo Namespace