Application.GetPackageInfos Method

Syntax

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

public PackageInfos GetPackageInfos (
    string strFolder,
    string serverName,
    string serverUserName,
    string serverPassword
)

public:
PackageInfos^ GetPackageInfos (
    String^ strFolder, 
    String^ serverName, 
    String^ serverUserName, 
    String^ serverPassword
)

public PackageInfos GetPackageInfos (
    String strFolder, 
    String serverName, 
    String serverUserName, 
    String serverPassword
)

public function GetPackageInfos (
    strFolder : String, 
    serverName : String, 
    serverUserName : String, 
    serverPassword : String
) : PackageInfos

Parameters

• strFolder
  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 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 method.

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

• serverUserName
  The SQL Server login name if you use SQL Server Authentication to log into the server; otherwise, null if you use Windows Authentication.

• serverPassword
  The SQL Server login password if you use SQL Server Authentication to log into the server; otherwise, null if you use Windows Authentication.

Return Value

A PackageInfos collection.

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.

Example

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

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.

Target Platforms

See Also