Server.UserOptions Property

  • Article

Gets the user options for the current connection to 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 UserOptions As UserOptions 
    Get
'Usage
Dim instance As Server 
Dim value As UserOptions 

value = instance.UserOptions

[SfcObjectAttribute(SfcObjectRelationship.ChildObject, SfcObjectCardinality.One)]
public UserOptions UserOptions { get; }

[SfcObjectAttribute(SfcObjectRelationship::ChildObject, SfcObjectCardinality::One)]
public:
property UserOptions^ UserOptions {
    UserOptions^ get ();
}

[<SfcObjectAttribute(SfcObjectRelationship.ChildObject, SfcObjectCardinality.One)>]
member UserOptions : UserOptions

function get UserOptions () : UserOptions

Property Value

Type: Microsoft.SqlServer.Management.Smo.UserOptions
A UserOptions object that specifies user options for the current connection to the instance of SQL Server.

Remarks

The UserOptions property points to the UserOptions object. This object can be used to view or modify user-specific settings, such as the ANSI settings, for the instance of SQL Server. The UserOptions object properties contain other settings that you can modify.

Examples

'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 (SMO)

Managing Servers