UserCollection Class
SQL Server 2012
The UserCollection class represents a collection of User objects that represent all the database users defined on a database.
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
The UserCollection type exposes the following members.
| 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 User object in the collection by index number. |
| Item[String] | Gets a User object in the collection by name. |
| Parent | Gets the Database object that is the parent of the User object. |
| SyncRoot | Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.) |
| Name | Description | |
|---|---|---|
| Add | Adds a user 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 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 UserCollection object 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.) |
| Name | Description | |
|---|---|---|
| initialized | This value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.) |
| Name | Description | |
|---|---|---|
| ICollection.CopyTo | Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.) |
A UserCollection object can be used to gain access to a set of database users. You can use the Item property to return a specific User object.
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
