Configurations.Contains Method

Articolo
12/15/2008

Returns a Boolean that indicates whether the items in the collection can be accessed by an index without throwing an exception.

Spazio dei nomi: Microsoft.SqlServer.Dts.Runtime
Assembly : Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Sintassi

'Dichiarazione
Public Function Contains ( _
    index As Object _
) As Boolean

public bool Contains (
    Object index
)

public:
bool Contains (
    Object^ index
)

public boolean Contains (
    Object index
)

public function Contains (
    index : Object
) : boolean

Parametri

index
The name, identity, ID, or index of the Configuration object to locate in the collection.

Valore restituito

A Boolean that indicates whether the collection can be accessed by name, identity, ID, or index. A value of true indicates that the collection can be accessed by using the syntax Configurations[index]. A value of false indicates that indexing cannot be used to retrieve items from the Configurations collection; using this property throws an exception.

Esempio

The following code example uses the Contains method to see if item syntax is available.

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

namespace Configurations_API
{
    class Program
    {
        static void Main(string[] args)
        {
            Package p = new Package();
            
            Configuration conf1 = p.Configurations.Add();
            conf1.ConfigurationString = "Conf1 Configuration String";
            conf1.ConfigurationType = DTSConfigurationType.EnvVariable;
            conf1.Description = "Some description for Conf1 configuration";
            conf1.Name = "Conf1";
            conf1.PackagePath = "A Variable Name in configuration Conf1";

            Configuration conf2 = p.Configurations.Add();
            conf2.ConfigurationString = "Conf2 Configuration String";
            conf2.ConfigurationType = DTSConfigurationType.ConfigFile;
            conf2.Description = "Some description for Conf2 configuration";
            conf2.Name = "Conf2";
            conf2.PackagePath = "A Variable Name in configuration Conf2";

            Configuration conf3 = p.Configurations.Add();
            conf3.ConfigurationString = "Conf3 Configuration String2";
            conf3.ConfigurationType = DTSConfigurationType.RegEntry;
            conf3.Description = "Conf3 description for Conf3 configuration2";
            conf3.Name = "Conf3";
            conf3.PackagePath = "A Variable Name in configuration Conf3";

            // Use Contains to see if item syntax is available.
            Boolean configContains = p.Configurations.Contains("Conf3");

            if (configContains)
            {
                // Use the item syntax of Configurations[x].
                String myName = p.Configurations[0].Name;
                Console.WriteLine("Name of configuration at position 0 is {0}", myName);
            }
            else
            {
                Console.WriteLine("Contains returned {0}", configContains);
            }
            Console.WriteLine();
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Configurations_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim p As Package =  New Package() 
 
            Dim conf1 As Configuration =  p.Configurations.Add() 
            conf1.ConfigurationString = "Conf1 Configuration String"
            conf1.ConfigurationType = DTSConfigurationType.EnvVariable
            conf1.Description = "Some description for Conf1 configuration"
            conf1.Name = "Conf1"
            conf1.PackagePath = "A Variable Name in configuration Conf1"
 
            Dim conf2 As Configuration =  p.Configurations.Add() 
            conf2.ConfigurationString = "Conf2 Configuration String"
            conf2.ConfigurationType = DTSConfigurationType.ConfigFile
            conf2.Description = "Some description for Conf2 configuration"
            conf2.Name = "Conf2"
            conf2.PackagePath = "A Variable Name in configuration Conf2"
 
            Dim conf3 As Configuration =  p.Configurations.Add() 
            conf3.ConfigurationString = "Conf3 Configuration String2"
            conf3.ConfigurationType = DTSConfigurationType.RegEnTry
            conf3.Description = "Conf3 description for Conf3 configuration2"
            conf3.Name = "Conf3"
            conf3.PackagePath = "A Variable Name in configuration Conf3"
 
            ' Use Contains to see if item syntax is available.
            Dim configContains As Boolean =  p.Configurations.Contains("Conf3") 
 
            If configContains = True Then
                ' Use the item syntax of Configurations[x].
                Dim myName As String =  p.Configurations(0).Name 
                Console.WriteLine("Name of configuration at position 0 is {0}", myName)
            Else 
                Console.WriteLine("Contains returned {0}", configContains)
            End If

            Console.WriteLine()
        End Sub
    End Class
End Namespace

Sample Output:

Name of configuration at position 0 is Conf1

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.

Piattaforme

Piattaforme di sviluppo

Per un elenco delle piattaforme supportate, vedere Requisiti hardware e software per l'Installazione di SQL Server 2005.

Piattaforme di destinazione