Settings 类

项目
04/26/2013

The Settings object represents a group of configurable settings on the instance of SQL Server.

继承层次结构

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

命名空间： Microsoft.SqlServer.Management.Smo
程序集： Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）

语法

声明
<SfcElementTypeAttribute("Setting")> _
Public NotInheritable Class Settings _
    Inherits SqlSmoObject _
    Implements IAlterable, IScriptable
用法
Dim instance As Settings

[SfcElementTypeAttribute("Setting")]
public sealed class Settings : SqlSmoObject, 
    IAlterable, IScriptable

[SfcElementTypeAttribute(L"Setting")]
public ref class Settings sealed : public SqlSmoObject, 
    IAlterable, IScriptable

[<SealedAttribute>]
[<SfcElementTypeAttribute("Setting")>]
type Settings =  
    class 
        inherit SqlSmoObject 
        interface IAlterable 
        interface IScriptable 
    end

public final class Settings extends SqlSmoObject implements IAlterable, IScriptable

Settings 类型公开以下成员。

属性

	名称	说明
	AuditLevel	Gets or sets the audit level for the instance of Microsoft SQL Server.
	BackupDirectory	Gets the default backup directory for the instance of Microsoft SQL Server.
	DefaultFile	Gets or sets the default data file directory for the instance of Microsoft SQL Server.
	DefaultLog	Gets or sets the default log file directory for the instance of Microsoft SQL Server.
	LoginMode	Gets or sets the logon mode for SQL Server.
	MailProfile	Gets or sets the mail profile for the instance of SQL Server.
	NumberOfLogFiles	Gets or sets the number of log files used by databases on the instance of SQL Server.
	OleDbProviderSettings	References a collection of OleDbProviderSettings objects. Each OleDbProviderSettings object represents an OLE DB provider setting.
	Parent	Gets the Server object that is the parent of the Settings object.
	PerfMonMode	Gets the polling behavior of Performance Monitor on the instance of SQL Server.
	Properties	Gets a collection of Property objects that represent the object properties. （从 SqlSmoObject 继承。）
	State	Gets the state of the referenced object. （从 SmoObjectBase 继承。）
	TapeLoadWaitTime	Gets or sets the time to wait for a tape to load on a tape backup device.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. （从 SqlSmoObject 继承。）
	UserData	Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。）

页首

方法

	名称	说明
	Alter	Updates any Settings object property changes on the instance of SQL Server.
	Discover	Discovers a list of type Object. （从 SqlSmoObject 继承。）
	Equals	（从 Object 继承。）
	FormatSqlVariant	Formats an object as SqlVariant type. （从 SqlSmoObject 继承。）
	GetContextDB	Gets the context database that is associated with this object. （从 SqlSmoObject 继承。）
	GetDBName	Gets the database name that is associated with the object. （从 SqlSmoObject 继承。）
	GetHashCode	（从 Object 继承。）
	GetPropValue	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetServerObject	Gets the server of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetType	（从 Object 继承。）
	Initialize()	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	IsObjectInitialized	Verifies whether the object has been initialized. （从 SqlSmoObject 继承。）
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. （从 SqlSmoObject 继承。）
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. （从 SqlSmoObject 继承。）
	Script()	Generates a Transact-SQL script that can be used to re-create the SQL Server settings.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the SQL Server settings as specified by the scripting options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. （从 SqlSmoObject 继承。）
	ToString	Returns a String that represents the referenced object. （从 SqlSmoObject 继承。）
	Validate	Validates the state of an object. （从 SmoObjectBase 继承。）

页首

事件

	名称	说明
	PropertyChanged	Represents the event that occurs when a property is changed. （从 SqlSmoObject 继承。）
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. （从 SqlSmoObject 继承。）

页首

显式接口实现

	名称	说明
	IAlienObject.Discover	Discovers any dependencies. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。（从 SqlSmoObject 继承。）
	IAlienObject.GetDomainRoot	Returns the root of the domain. （从 SqlSmoObject 继承。）
	IAlienObject.GetParent	Gets the parent of this object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。（从 SqlSmoObject 继承。）
	IAlienObject.GetPropertyType	Gets the type of the specified property. （从 SqlSmoObject 继承。）
	IAlienObject.GetPropertyValue	Gets the value of the specified property. （从 SqlSmoObject 继承。）
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。（从 SqlSmoObject 继承。）
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. （从 SqlSmoObject 继承。）
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. （从 SqlSmoObject 继承。）
	IAlienObject.SetPropertyValue	Sets the property value. （从 SqlSmoObject 继承。）
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. （从 SqlSmoObject 继承。）

页首

注释

后续版本的 Microsoft SQL Server 将删除该功能。请避免在新的开发工作中使用该功能，并着手修改当前还在使用该功能的应用程序。

To get Settings object properties, users can be a member of the public fixed server role.

To set Settings object properties, users must be a member of the sysadmin fixed server role.

Thread Safety

此类型的任何公共静态（Microsoft Visual Basic 中的 Shared）成员在多线程操作中是安全的。但不保证所有实例成员都是线程安全的。

示例

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

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared）成员都是线程安全的。不保证所有实例成员都是线程安全的。

通过