• Article

Application.GetDtsServerPackageInfos Method

Gets a PackageInfos collection that contains the packages stored in the SSIS Package Store on an instance of SQL Server, within the specified folder.

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

Syntax

'Declaration
Public Function GetDtsServerPackageInfos ( _
    sPackageFolder As String, _
    sServerName As String _
) As PackageInfos
'Usage
Dim instance As Application
Dim sPackageFolder As String
Dim sServerName As String
Dim returnValue As PackageInfos

returnValue = instance.GetDtsServerPackageInfos(sPackageFolder, _
    sServerName)

public PackageInfos GetDtsServerPackageInfos(
    string sPackageFolder,
    string sServerName
)

public:
PackageInfos^ GetDtsServerPackageInfos(
    String^ sPackageFolder, 
    String^ sServerName
)

member GetDtsServerPackageInfos : 
        sPackageFolder:string * 
        sServerName:string -> PackageInfos 

public function GetDtsServerPackageInfos(
    sPackageFolder : String, 
    sServerName : String
) : PackageInfos

Parameters

  • sPackageFolder
    Type: System.String
    The folder under Stored Packages that contains the packages you want to enumerate. If you want package information from the msdb database in SQL Server, you can also use the GetPackageInfos method. The folders in which packages are stored within the SSIS Package Store can be created from the Stored Packages node in Management Studio, by the dtutil.exe command prompt utility, or by the CreateFolderOnDtsServer method.
  • sServerName
    Type: System.String
    The name of the SQL Server instance where the packages reside. For the local server, use the server name or "."; "(local)" and "localhost" are not acceptable.

Return Value

Type: Microsoft.SqlServer.Dts.Runtime.PackageInfos
A PackageInfos collection that contains PackageInfo objects.

Remarks

This method connects to the SSIS Service to gather information about packages stored in the SSIS Package Store. It returns a PackageInfo object for each package stored in the specified logical folder. From the PackageInfo object, you can obtain the package's name, description, creation date, version, and additional information.

For more information, see Managing Packages and Folders Programmatically.

Examples

The following code example enumerates properties from the packages found in the PackageInfos collection, which is retrieved from the Application object.

static void Main(string[] args)
{
    Application app = new Application();

    PackageInfos pInfos = app.GetDtsServerPackageInfos(@"File System", "yourserver");
    foreach (PackageInfo pinfo in pInfos)
        Console.WriteLine(pinfo.Folder + " " + pinfo.Description);
}

Sub Main(ByVal args() As String)
    Dim app As Application =  New Application() 
 
    Dim pInfos As PackageInfos =  app.GetDtsServerPackageInfos("File System","yourserver") 
    For Each pinfo As PackageInfo In pInfos
        Console.WriteLine(pinfo.Folder + " " + pinfo.Description)
    Next
End Sub