Instance.InstanceConfigurationFileVersion Property

Article
12/03/2008

Gets or sets the version number of the instance configuration.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Property InstanceConfigurationFileVersion As Version

public Version InstanceConfigurationFileVersion { get; set; }

public:
property Version^ InstanceConfigurationFileVersion {
    Version^ get ();
    void set (Version^ value);
}

/** @property */
public Version get_InstanceConfigurationFileVersion ()

/** @property */
public void set_InstanceConfigurationFileVersion (Version value)

public function get InstanceConfigurationFileVersion () : Version

public function set InstanceConfigurationFileVersion (value : Version)

Property Value

A Version object specifying the instance configuration version.

Remarks

The InstanceConfigurationFileVersion property is optional.

Use the InstanceConfigurationFileVersion property if you want to specify which version of SQL Server Notification Services the instance configuration conforms to or to track the instance configuration version using your own version numbers.

When you first create the instance, if you do not specify a version number, Notification Services enters version 0.0.0.0 in the instance database. For subsequent updates, Notification Services uses the most recent version number, which it obtains from the database.

When you update the instance, Notification Services always enters the version number into the database regardless of any other changes in the ICF or application definition file (ADF). The updated version number must be equal to or greater than the previous version number.

Example

The following examples show how to define the instance configuration version:

myInstance.InstanceConfigurationFileVersion = 
    new Version(1, 0, 0, 0);

myInstance.InstanceConfigurationFileVersion = _
    New Version(1, 0, 0, 0)

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms