Role Property

  • Article

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The Role property identifies the initial security role assigned to the Microsoft SQL Server database user.

Syntax

object
.Role [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list
  • value
    A string that identifies an existing fixed or user-defined database role by name

Data Type

String

Modifiable

Read/write when using the User object to create a database user.

Prototype (C/C++)

HRESULT GetRole(SQLDMO_LPBSTR pRetVal);
HRESULT SetRole(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

If not specified, a user created by using the User object is given membership in the fixed database security role public.

Applies To:

User Object