• Article

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
Public property ConfigValue Gets or sets the new value of the configuration option.
Public property Description Gets a textual description of the configuration property.
Public property DisplayName Gets the name of the configuration option being modified.
Public property IsAdvanced Gets the Boolean property value that specifies whether the configuration option is an advanced option.
Public property 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.
Public property Maximum Gets the maximum value to which the configuration option can be set.
Public property Minimum Gets the maximum value to which the configuration option can be set.
Public property Number Gets the index position of the configuration option.
Public property RunValue Gets the current running value of the configuration option.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method 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.

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.