LogProviders.Contains(Object) 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.

Specifies whether an item can be retrieved from the LogProviders collection using indexing without throwing an exception.

public:
 bool Contains(System::Object ^ index);

public bool Contains (object index);

member this.Contains : obj -> bool

Public Function Contains (index As Object) As Boolean

Parameters

index: Object

An object that contains the numeric index or identity of the object in the collection.

Returns

Boolean

A Boolean that indicates whether items can be retrieved using indexing. A value of true indicates that the syntax LogProviders[x] can be used without throwing an exception. A value of false indicates that indexing cannot be used to retrieve items from the LogProviders collection.

Examples

The following code sample uses Contains method to determine if a log provider with the name "SSIS log provider for Text files" is in the collection. The method returns a Boolean.

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

namespace LogProviders_Tests  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            // The package is one of the SSIS Samples.  
            string mySample = @"C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx";  

            // Create the Application, and load the sample.  
            Application app = new Application();  
            Package pkg = app.LoadPackage(mySample, null);  
            LogProviders logProvs = pkg.LogProviders;  

            // Search for the "SSIS log provider for Text files"  
            // in the collection  
            if (logProvs.Contains("SSIS log provider for Text files"))  
                Console.WriteLine("The collection contains {0} provider", logProvs[0].CreationName);  
            else  
                Console.WriteLine("The collection does not contain the SSIS log provider for Text files");  
        }  
    }  
}

Imports System  
Imports System.Collections.Generic  
Imports System.Text  
Imports Microsoft.SqlServer.Dts.Runtime  

Namespace LogProviders_Tests  
    Class Program  
        Shared  Sub Main(ByVal args() As String)  
            ' The package is one of the SSIS Samples.  
            Dim mySample As String =  "C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx"   

            ' Create the Application, and load the sample.  
            Dim app As Application =  New Application()   
            Dim pkg As Package =  app.LoadPackage(mySample,Nothing)   
            Dim logProvs As LogProviders =  pkg.LogProviders   

            ' Search for the "SSIS log provider for Text files"  
            ' in the collection  
            If logProvs.Contains("SSIS log provider for Text files") Then  
                Console.WriteLine("The collection contains {0} provider", logProvs(0).CreationName)  
            Else   
                Console.WriteLine("The collection does not contain the SSIS log provider for Text files")  
            End If  
         End Sub  
    End Class  
End Namespace

Sample Output:

The collection contains DTS.LogProviderTextFile.1 provider

Remarks

If a log provider is added using the Add method, the Name of the log provider defaults to a GUID.

Applies to

Share via