Share via

UserOptions Class

  • Article

The UserOptions object represents a set configurable server options that relate specifically to users.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.UserOptions

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

Syntax

'Declaration
<SfcElementTypeAttribute("UserOption")> _
Public NotInheritable Class UserOptions _
    Inherits SqlSmoObject _
    Implements IAlterable, IScriptable, ISfcSupportsDesignMode
'Usage
Dim instance As UserOptions

[SfcElementTypeAttribute("UserOption")]
public sealed class UserOptions : SqlSmoObject, 
    IAlterable, IScriptable, ISfcSupportsDesignMode

[SfcElementTypeAttribute(L"UserOption")]
public ref class UserOptions sealed : public SqlSmoObject, 
    IAlterable, IScriptable, ISfcSupportsDesignMode

[<SealedAttribute>]
[<SfcElementTypeAttribute("UserOption")>]
type UserOptions =  
    class 
        inherit SqlSmoObject 
        interface IAlterable 
        interface IScriptable 
        interface ISfcSupportsDesignMode 
    end

public final class UserOptions extends SqlSmoObject implements IAlterable, IScriptable, ISfcSupportsDesignMode

The UserOptions type exposes the following members.

Properties

  Name Description
Public property AbortOnArithmeticErrors Gets or sets the Boolean property value that specifies whether arithmetic divide by zero errors are terminated or not.
Public property AbortTransactionOnError Gets or sets the Boolean property value that specifies whether transactions are automatically terminated or not.
Public property AnsiNullDefaultOff Gets or sets the Boolean property value that specifies whether new columns created allow null values by default or not.
Public property AnsiNullDefaultOn Gets or sets the Boolean property value that specifies whether new columns created allow null values by default or not.
Public property AnsiNulls Gets or sets the Boolean property value that specifies whether null values can be used in comparisons or not.
Public property AnsiPadding Gets or sets the Boolean property value that specifies whether trailing blanks are inserted (padded) or removed (trimmed) in char, varchar, binary, and varbinary columns.
Public property AnsiWarnings Gets or sets the Boolean property value that specifies whether warning messages are generated when nulls are encountered in aggregate functions such as SUM, AVG, MAX, MIN, STDEV, STDEVP, VAR, VARP, or COUNT.
Public property ConcatenateNullYieldsNull Gets or sets the Boolean property value that specifies whether a value that is concatenated with a null value results in the value or a null value.
Public property CursorCloseOnCommit Gets or sets the Boolean property value that specifies whether any open cursors are closed when a transaction is committed or rolled back.
Public property DisableDefaultConstraintCheck Gets or sets the Boolean property value that specifies whether interim deferred violation checking is used when connecting to a server running Microsoft SQL Server version 6.x.
Public property IgnoreArithmeticErrors Gets or sets the Boolean property value that specifies whether error messages are generated or not when divide by zero errors occur.
Public property ImplicitTransactions Gets or sets the Boolean property value that specifies whether a Transact-SQL transaction is started automatically after the previous transaction is committed or rolled back.
Public property NoCount Gets or sets the Boolean property value that specifies whether queries return the number of rows affected.
Public property NumericRoundAbort Gets or sets the Boolean property value that specifies whether an error is generated when loss of precision occurs in an expression.
Public property Parent Gets the Server object that is the parent of the UserOptions object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property QuotedIdentifier Gets or sets the Boolean property value that specifies whether double or single quotation marks can be used to delimit identifiers or not.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter() Updates any UserOptions object property changes on the instance of Microsoft SQL Server. 
Public method Alter(Boolean) Updates any UserOptions object property changes on the instance of Microsoft SQL Server with the option to override value checking. 
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method Script() Returns a script as a String Collection.
Public method Script(ScriptingOptions) Returns a Script object with specific scripting options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

To get or set UserOptions object properties, users can be a member of the public fixed server role. The setting applies to the current user.

Thread Safety

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

Examples

Configuring SQL Server in SMO

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Configuring SQL Server in SMO