Package.VersionComments Property

Article
12/03/2008

Gets or sets the comments associated with the package.

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

Syntax

'Declaration
Public Property VersionComments As String

public string VersionComments { get; set; }

public:
property String^ VersionComments {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_VersionComments ()

/** @property */
public void set_VersionComments (String value)

public function get VersionComments () : String

public function set VersionComments (value : String)

Property Value

A String that contains the version comments for the package.

Example

The following example retrieves version information from a package installed with the SSIS samples.

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

namespace Package_API
{
    class Program
    {
        static void Main(string[] args)
        {
            Application app = new Application();
            Package pkg = new Package();
            pkg = app.LoadPackage(@"C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx", null);

            // Review several properties on the sample package using different techniques.
            int pkgBuild = pkg.VersionBuild;
            int pkgVerMajor = pkg.VersionMajor;
            int pkgVerMinor = pkg.VersionMinor;
            String entireVersion = pkgVerMajor.ToString() + "." + pkgVerMinor.ToString();

            Console.WriteLine("Build number for package {0}", pkgBuild);
            Console.WriteLine("any comments? {0}", pkg.VersionComments);
            Console.WriteLine("What is the GUID? {0}", pkg.VersionGUID);
            Console.WriteLine("Version numbers {0}", entireVersion);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Package_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim pkg As Package =  New Package() 
            pkg = app.LoadPackage("C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx", Nothing)
 
            ' Review several properties on the sample package using different techniques.
            Dim pkgBuild As Integer =  pkg.VersionBuild 
            Dim pkgVerMajor As Integer =  pkg.VersionMajor 
            Dim pkgVerMinor As Integer =  pkg.VersionMinor 
            Dim entireVersion As String =  pkgVerMajor.ToString() + "." + pkgVerMinor.ToString() 
 
            Console.WriteLine("Build number for package {0}", pkgBuild)
            Console.WriteLine("any comments? {0}", pkg.VersionComments)
            Console.WriteLine("What is the GUID? {0}", pkg.VersionGUID)
            Console.WriteLine("Version numbers {0}", entireVersion)
        End Sub
    End Class
End Namespace

Sample Output:

Build number for package 143

any comments?

What is the GUID? {0FF64FA0-2FB7-49C1-BB20-6439EDD1EE44}

Version numbers 1.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

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

Share via