Server.Settings Property

Gets modifiable settings for the instance of SQL Server.

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

Syntax

'Declaration
<SfcObjectAttribute(SfcObjectRelationship.ChildObject, SfcObjectCardinality.One)> _
Public ReadOnly Property Settings As Settings 
    Get
'Usage
Dim instance As Server 
Dim value As Settings 

value = instance.Settings
[SfcObjectAttribute(SfcObjectRelationship.ChildObject, SfcObjectCardinality.One)]
public Settings Settings { get; }
[SfcObjectAttribute(SfcObjectRelationship::ChildObject, SfcObjectCardinality::One)]
public:
property Settings^ Settings {
    Settings^ get ();
}
[<SfcObjectAttribute(SfcObjectRelationship.ChildObject, SfcObjectCardinality.One)>]
member Settings : Settings
function get Settings () : Settings

Property Value

Type: Microsoft.SqlServer.Management.Smo.Settings
A Settings object that specifies modifiable settings for the instance of SQL Server.

Remarks

The Settings property points to the Settings object. This can be used to view or modify settings for the instance of SQL Server, such as the default location of the log, the data, and the backup file storage. The Settings object properties contain other settings that you can modify.

Examples

Visual Basic

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Display information about the instance of SQL Server in Information and Settings.
Console.WriteLine("OS Version = " & srv.Information.OSVersion)
Console.WriteLine("State = " & srv.Settings.State.ToString)
'Display information specific to the current user in UserOptions.
Console.WriteLine("Quoted Identifier support = " & srv.UserOptions.QuotedIdentifier)
'Modify server settings in Settings.

srv.Settings.LoginMode = ServerLoginMode.Integrated
'Modify settings specific to the current connection in UserOptions.
srv.UserOptions.AbortOnArithmeticErrors = True
'Run the Alter method to make the changes on the instance of SQL Server.
srv.Alter()

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
Write-Host "OS Version =" $srv.Information.OSVersion
Write-Host "State =" $srv.Settings.State.ToString()
Write-Host "Quoted Identifier support =" $srv.UserOptions.QuotedIdentifier
$srv.Settings.LoginMode = [Microsoft.SqlServer.Management.Smo.ServerLoginMode]::Integrated
$srv.UserOptions.AbortOnArithmeticErrors = $TRUE
$srv.Alter()

See Also

Reference

Server Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Configuring SQL Server in SMO

Managing Servers