Application.GetPackageInfos(String, String, String, String) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a PackageInfos collection that contains the packages stored in an instance of SQL Server, within the specified logical folder, by using the server name, user name, and password.

public:
 Microsoft::SqlServer::Dts::Runtime::PackageInfos ^ GetPackageInfos(System::String ^ strFolder, System::String ^ serverName, System::String ^ serverUserName, System::String ^ serverPassword);

public Microsoft.SqlServer.Dts.Runtime.PackageInfos GetPackageInfos (string strFolder, string serverName, string serverUserName, string serverPassword);

member this.GetPackageInfos : string * string * string * string -> Microsoft.SqlServer.Dts.Runtime.PackageInfos

Public Function GetPackageInfos (strFolder As String, serverName As String, serverUserName As String, serverPassword As String) As PackageInfos

Parameters

strFolder: String

The logical folder that contains the packages you want to enumerate. If you want package information from the File System folder in the SSIS Package Store, use the GetDtsServerPackageInfos(String, String) method. The logical folders in which packages are stored within MSDB can be created from the Stored Packages\MSDB node in Management Studio, by the dtutil.exe command prompt utility, or by the CreateFolderOnSqlServer(String, String, String, String, String) method.

serverName: String

The name of the SQL Server instance where the packages reside.

serverUserName: String

The account name used to log on to the instance of SQL Server, if you need to log in to SQL Server using standard authentication. If you are using Windows Authentication, use null.

serverPassword: String

The password of the user account, if you need to log in to SQL Server using standard authentication. If you are using Windows Authentication, use null.

Returns

PackageInfos

A PackageInfos collection.

Examples

The following code example retrieves the collection from the application object and iterates over each object in the collection, printing its description.

Application app = new Application();  
PackageInfos pInfos = app.GetPackageInfos("\\", "yourserver", null, null);  
foreach (PackageInfo pInfo in pInfos)  
{  
    Console.WriteLine("Name: {0}", pInfo.Name);  
}

Dim app As Application =  New Application()   
Dim pInfos As PackageInfos =  app.GetPackageInfos("\\","yourserver",Nothing,Nothing)   
For Each pInfo As PackageInfo In pInfos  
    Console.WriteLine("Name: {0}", pInfo.Name)  
Next

Sample Output:

Name: Maintenance Plans

Remarks

This method bypasses the SSIS Service and connects directly to an instance of SQL Server to gather information about packages stored in the MSDB database. 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.

Applies to