ConfigProperty Class

The ConfigProperty object contains information pertaining to a Microsoft SQL Server configuration option, such as maximum, minimum, current, and new values.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.ConfigProperty

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

Syntax

'Declaration
Public NotInheritable Class ConfigProperty
'Usage
Dim instance As ConfigProperty

public sealed class ConfigProperty

public ref class ConfigProperty sealed

[<SealedAttribute>]
type ConfigProperty =  class end

public final class ConfigProperty

The ConfigProperty type exposes the following members.

Properties

	Name	Description
	ConfigValue	Gets or sets the new value of the configuration option.
	Description	Gets a textual description of the configuration property.
	DisplayName	Gets the name of the configuration option being modified.
	IsAdvanced	Gets the Boolean property value that specifies whether the configuration option is an advanced option.
	IsDynamic	Gets the Boolean property value that specifies whether the configuration option is immediately updated or waits until the instance of Microsoft SQL Server is restarted.
	Maximum	Gets the maximum value to which the configuration option can be set.
	Minimum	Gets the maximum value to which the configuration option can be set.
	Number	Gets the index position of the configuration option.
	RunValue	Gets the current running value of the configuration option.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Remarks

The ConfigProperty object is used to modify or retrieve information about configuration options that are children of the Configuration object.

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

To set ConfigProperty object properties, users must have ALTER SETTINGS permission on the parent server, or be a member of the sysadmin and serveradmin fixed server role.

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

Setting Server Configuration Options

Configuring SQL Server in SMO