Database.Roles Property

Represents a collection of DatabaseRole objects. Each DatabaseRole object represents a role defined on the database.

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

Syntax

'Declaration
Public ReadOnly Property Roles As DatabaseRoleCollection
public DatabaseRoleCollection Roles { get; }
public:
property DatabaseRoleCollection^ Roles {
    DatabaseRoleCollection^ get ();
}
/** @property */
public DatabaseRoleCollection get_Roles ()
public function get Roles () : DatabaseRoleCollection

Property Value

A DatabaseRoleCollection object that represents all the roles defined on the database.

Remarks

Updated text:17 July 2006

Specific database roles can be referenced by using this collection by specifying the name of the database role. To add a new database role to the collection, call the database role constructor, DatabaseRole.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server

'Reference the AdventureWorks database.
Dim db As Database
db = srv.Databases("AdventureWorks")

'Display all the database roles in the database.
Dim ro As DatabaseRole
For Each ro In db.Roles
   Console.WriteLine(ro.Name)
Next

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Database Class
Database Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

How to: Create, Alter, and Remove a Database in Visual Basic .NET
Managing Users, Roles, and Logins
Creating, Altering, and Removing Databases
CREATE DATABASE (Transact-SQL)

Change History

Release

History

17 July 2006

Changed content:
  • Added text to the Remarks section.

  • Added code to the Example section.