UserCollection Class

The UserCollection class represents a collection of User objects that represent all the database users defined on a database.

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.UserCollection

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

Syntax

'Bildirim
Public NotInheritable Class UserCollection _
    Inherits SimpleObjectCollectionBase
'Kullanım
Dim instance As UserCollection

public sealed class UserCollection : SimpleObjectCollectionBase

public ref class UserCollection sealed : public SimpleObjectCollectionBase

[<SealedAttribute>]
type UserCollection =  
    class
        inherit SimpleObjectCollectionBase
    end

public final class UserCollection extends SimpleObjectCollectionBase

The UserCollection 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 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.)

Top

Methods

	Name	Description
	Add	Adds a user to the collection.
	AddExisting	Adds an object to the collection. (Inherited from AbstractCollectionBase.)
	AddImpl	Adds the specified object to this collection (Inherited from SortedListCollectionBase.)
	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.)
	Finalize	(Inherited from Object.)
	GetCollectionElementType	Gets the Collection Element Type. (Inherited from SmoCollectionBase.)
	GetEnumerator	Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
	GetHashCode	(Inherited from Object.)
	GetItemById(Int32)	Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
	GetItemById(Int32, String)	Extracts a member from the referenced collection using a system-defined, unique identifier and name. (Inherited from SmoCollectionBase.)
	GetObjectByIndex	Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.)
	GetType	(Inherited from Object.)
	ImplAddExisting	Adds an existing specified object to this collection (Inherited from SortedListCollectionBase.)
	InitializeChildCollection()	Initializes the child collections of the referenced collection. (Inherited from SmoCollectionBase.)
	InitializeChildCollection(Boolean)	Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection. (Inherited from SmoCollectionBase.)
	InitInnerCollection	Initializes the collection. (Inherited from SimpleObjectCollectionBase.)
	ItemById	Extracts a member from the UserCollection object using a system-defined, unique identifier.
	MemberwiseClone	(Inherited from Object.)
	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.)
	ValidateParentObject	Validates the parent object exists. (Inherited from SmoCollectionBase.)

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 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.

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

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Using Collections