RuleCollection Class
The RuleCollection class represents a collection of Rule objects that represent all the rules defined on the instance of SQL Server.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
Microsoft.SqlServer.Management.Smo.SmoCollectionBase
Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
Microsoft.SqlServer.Management.Smo.SchemaCollectionBase
Microsoft.SqlServer.Management.Smo.RuleCollection
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public NotInheritable Class RuleCollection _
Inherits SchemaCollectionBase
'Usage
Dim instance As RuleCollection
public sealed class RuleCollection : SchemaCollectionBase
public ref class RuleCollection sealed : public SchemaCollectionBase
[<SealedAttribute>]
type RuleCollection =
class
inherit SchemaCollectionBase
end
public final class RuleCollection extends SchemaCollectionBase
The RuleCollection 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] | Gets a Rule object in the collection by index number. | |
Item[String] | Gets a Rule object in the collection by name. | |
Item[String, String] | Gets a Rule object in the collection by name. | |
Parent | Gets the Database object that is the parent of the RuleCollection object. | |
SyncRoot | Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.) |
Top
Methods
Name | Description | |
---|---|---|
Add | Adds a new Rule to the Rule Collection | |
AddExisting | Adds an object to the collection. (Inherited from AbstractCollectionBase.) | |
Contains(String) | Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from SchemaCollectionBase.) | |
Contains(String, String) | Validates whether the parameter collection contains a member with a name equal to the specified string and with the specified schema. (Inherited from SchemaCollectionBase.) | |
CopyTo | Copies the collection objects to a one-dimensional array beginning at the index value specified. | |
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 | Extracts a member from the RuleCollection collection using a system-defined, unique identifier. | |
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.) | |
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
Remarks
A RuleCollection object can be used to gain access to a set of rules. You can use the Item property to return a specific Rule object.
Examples
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.