Application.GetServerVersionEx Method

Article
12/03/2008

Returns the edition, product level, and other values that indicate the version of SSIS installed.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Sub GetServerVersionEx ( _
    server As String, _
    <OutAttribute> ByRef editionID As Integer, _
    <OutAttribute> ByRef ssisEditionID As DTSProductLevel, _
    <OutAttribute> ByRef productVersion As String, _
    <OutAttribute> ByRef productLevel As String _
)

public void GetServerVersionEx (
    string server,
    out int editionID,
    out DTSProductLevel ssisEditionID,
    out string productVersion,
    out string productLevel
)

public:
void GetServerVersionEx (
    String^ server, 
    [OutAttribute] int% editionID, 
    [OutAttribute] DTSProductLevel% ssisEditionID, 
    [OutAttribute] String^% productVersion, 
    [OutAttribute] String^% productLevel
)

public void GetServerVersionEx (
    String server, 
    /** @attribute OutAttribute() */ /** @ref */ int editionID, 
    /** @attribute OutAttribute() */ /** @ref */ DTSProductLevel ssisEditionID, 
    /** @attribute OutAttribute() */ /** @ref */ String productVersion, 
    /** @attribute OutAttribute() */ /** @ref */ String productLevel
)

JScript does not support passing value-type arguments by reference.

Parameters

server
The name of the server to get the product version information from.

editionID
An out parameter containing an integer that indicates the edition of the product. The mapping of the editionID to the edition name is shown in the Remarks section.

ssisEditionID
An out parameter containing a value from the DTSProductLevel enumeration.

productVersion
An out parameter containing the build number as seen in Help / About, formatted as major.minor.build.

productLevel
An out parameter providing the service pack level of the SSIS server.

Remarks

New:5 December 2005

EditionID	Edition Name
0xA485ED98	Standard Edition
0x6B9471A8	Enterprise Edition
0x81C1F4D2	Developer Edition
0x2467BCA1	Enterprise Evaluation Edition

Example

The following example shows the values returned for each out parameter

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            String serverName = "yourServerName";
            int ed;
            DTSProductLevel prodLevel = new DTSProductLevel();
            String prodVersion;
            string prodReleaseLevel;   
            Application app = new Application();
            app.GetServerVersionEx(serverName, out ed, out prodLevel, out prodVersion, out prodReleaseLevel);

            Console.WriteLine("servernName:     {0}", serverName);
            Console.WriteLine("Edition:         {0}", ed);
            Console.WriteLine("prodLevel:       {0}", prodLevel);
            Console.WriteLine("prodVersion:     {0}", prodVersion);
            Console.WriteLine("prodReleaseLevel {0}", prodReleaseLevel);
        }
    }
}

Imports System 
Imports System.Collections.Generic 
Imports System.Text 
Imports Microsoft.SqlServer.Dts.Runtime 
Namespace Microsoft.SqlServer.SSIS.Samples 

    Class Program 

        Shared Sub Main(ByVal args As String()) 
            Dim servernName As String = "yourServerName" 
            Dim ed As Integer 
            Dim prodLevel As DTSProductLevel = New DTSProductLevel 
            Dim prodVersion As String 
            Dim prodReleaseLevel As String 
            Dim app As Application = New Application 
            app.GetServerVersionEx(servernName, ed, prodLevel, prodVersion, prodReleaseLevel) 

            Console.WriteLine("servernName: {0}", servernName) 
            Console.WriteLine("Edition: {0}", ed) 
            Console.WriteLine("prodLevel: {0}", prodLevel) 
            Console.WriteLine("prodVersion: {0}", prodVersion) 
            Console.WriteLine("prodReleaseLevel {0}", prodReleaseLevel) 
            Console.WriteLine 
        End Sub 
    End Class 
End Namespace

Sample Output:

serverName: <your server name>

Editon: 4

prodLevel: Enterprise

prodVersion: 9.00.1306.00

prodReleaseLevel: CTP16

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