Server.Roles Property

Represents a collection of ServerRole objects. Each ServerRole object represents a role defined on the instance of Microsoft SQL Server.

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

Syntax

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

Property Value

A ServerRoleCollection object that represents all the roles defined on the instance of SQL Server.

Remarks

Updated text:

The Roles property points to the ServerRoleCollection object. You can use the collection to reference the fixed server roles the instance of SQL Server.

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
'Display the fixed server roles.
Dim sr As ServerRole
For Each sr In srv.Roles
   Console.WriteLine(sr.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

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

Other Resources

How to: Reference an Object by Using a Collection in Visual Basic .NET
Using Collections
Setting Properties
Managing Servers

Change History

Release

History

New content:
  • Added code sample to the Example section.

  • Added to the description in the Remarks section.