Класс Settings

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

Все общие статические члены этого типа (Shared в Microsoft 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()

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.

См. также

Справочник

Пространство имен Microsoft.SqlServer.Management.Smo

Другие ресурсы

Настройка SQL Server в SMO