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 | Gets 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.) | |
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.) | |
GetEnumerator | Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
ItemById | Returns a plan guide object as indicated by the identifier of that plan guide. | |
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.) |
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.