DtsProperties.Contains Method
Returns a Boolean that indicates whether the items in the collection can be accessed by using the name, identity, or index of the DtsProperty object.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public Function Contains ( _
index As Object _
) As Boolean
'Usage
Dim instance As DtsProperties
Dim index As Object
Dim returnValue As Boolean
returnValue = instance.Contains(index)
public bool Contains(
Object index
)
public:
bool Contains(
Object^ index
)
member Contains :
index:Object -> bool
public function Contains(
index : Object
) : boolean
Parameters
- index
Type: System.Object
The name, identity, or index of the DtsProperty object.
Return Value
Type: System.Boolean
A Boolean that indicates whether the collection can be accessed by name, identity, or index. A value of true indicates that the collection can be accessed by using the syntax DtsProperties[index].
A value of false indicates that indexing cannot be used to retrieve items from the DtsProperties collection.
Examples
The following code sample uses the Contains method to see if one of the properties in the collection is "CertificateObject".
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
namespace DtsProperties_API
{
class Program
{
static void Main(string[] args)
{
Package pkg = new Package();
// Get the Properties collection from the package.
// This shows the default properties set on new packages.
DtsProperties pkgProperties = pkg.Properties;
// Create the enumerator.
PropertyEnumerator myEnumerator = pkgProperties.GetEnumerator();
// Show the use of the Contains method.
Boolean containsCertObj = pkgProperties.Contains("CertificateObject");
Console.WriteLine("Contains CertificateObject? {0}", containsCertObj);
// Show the use of the item[x] syntax.
String aName = pkgProperties[5].Name;
Console.WriteLine("Property 5 is {0}", aName);
// Show the use of the MoveNext and Current methods.
int i = 0;
while ((myEnumerator.MoveNext()) && (myEnumerator.Current != null))
{
Console.WriteLine("[{0}] {1}", i++, myEnumerator.Current.Name);
}
}
}
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Namespace DtsProperties_API
Class Program
Shared Sub Main(ByVal args() As String)
Dim pkg As Package = New Package()
' Get the Properties collection from the package.
' This shows the default properties set on new packages.
Dim pkgProperties As DtsProperties = pkg.Properties
' Create the enumerator.
Dim myEnumerator As PropertyEnumerator = pkgProperties.GetEnumerator()
' Show the use of the Contains method.
Dim containsCertObj As Boolean = pkgProperties.Contains("CertificateObject")
Console.WriteLine("Contains CertificateObject? {0}", containsCertObj)
' Show the use of the item[x] syntax.
Dim aName As String = pkgProperties(5).Name
Console.WriteLine("Property 5 is {0}", aName)
' Show the use of the MoveNext and Current methods.
Dim i As Integer = 0
While (myEnumerator.MoveNext()) &&(myEnumerator.Current <> Nothing)
Console.WriteLine("[{0}] {1}",i = Console.WriteLine("[{0}] {1}",i + 1
End While
End Sub
End Class
End Namespace
Sample Output:
Contains CertificateObject? True
Property 5 is Configurations
[0] CertificateContext
[1] CertificateObject
[2] CheckpointFileName
[3] CheckpointUsage
[4] CheckSignatureOnLoad
[5] Configurations
[6] Connections
[7] CreationDate
[8] CreationName
[9] CreatorComputerName
[10] CreatorName
[11] DelayValidation
. . .
[63] VersionGUID
[64] VersionMajor
[65] VersionMinor
[66] Warnings
See Also