Export (0) Print
Expand All

PlanGuideCollection Class

Collection of plan guide objects.

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

[<SealedAttribute>]
[<DefaultMemberAttribute("Item")>]
type PlanGuideCollection =  
    class 
        inherit SimpleObjectCollectionBase 
    end

The PlanGuideCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public propertyIsSynchronizedGets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public propertyItem(Int32)Returns an item from a collection of plan guide objects that are identified by the integer ID index of the item.
Public propertyItem(String)Returns an Item from a collection of plan guide objects identified by the Name property of the item.
Public propertyParentGets a database object that represents the parent of the collection.
Public propertySyncRootGets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)
Top

  NameDescription
Public methodAddAdds a plan guide object to the collection.
Protected methodAddExistingAdds an object to the collection. (Inherited from AbstractCollectionBase.)
Public methodContainsVerifies whether the specified object exists in the collection. (Inherited from SimpleObjectCollectionBase.)
Public methodCopyToCopies 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 methodEquals (Inherited from Object.)
Public methodGetEnumeratorReturns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodItemByIdReturns a plan guide object as indicated by the identifier of that plan guide.
Public methodRefresh()Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public methodRefresh(Boolean)Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public methodRemove(String)Removes a plan guide from a plan guide collection based on the PlanGuide Name property.
Public methodRemove(PlanGuide)Removes a plan guide from a plan guide collection.
Public methodToString (Inherited from Object.)
Top

  NameDescription
Protected fieldinitializedThis value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollectionCopyToCopies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft