DtsWarnings.Item Property (Object)

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Returns a DtsWarning object from the collection.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

public DtsWarning this[
    object index
] { get; }

public:
property DtsWarning^ default[
    Object^ index
] {
    DtsWarning^ get(Object^ index);
}

member Item : 
        index:Object -> DtsWarning with get

Public ReadOnly Property Item (
    index As Object
) As DtsWarning

Parameters

index
Type: System.Object

The name, identity, or index of the DtsWarning object to retrieve from the collection.

Property Value

Type: Microsoft.SqlServer.Dts.Runtime.DtsWarning

A DtsWarning object.

Remarks

If the call to the Contains method returns true, you can access the specified element in the collection by using the syntax DtsWarning[index]. If the Contains method returns false, this property will throw an exception. In C#, this property is the indexer for the DtsWarnings class.

Examples

Legacy Code Example

The following code example creates a Send Mail task and adds it to a package. Not all of the required properties of the Send Mail task are set, so when the package runs, there are errors and warnings in the DtsErrors and DtsWarnings collections. The Contains method is used to see if the collections can be accessed using the DtsWarnings[index] syntax, and if so, obtains some properties using that syntax.

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

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Package package = new Package();
            TaskHost taskH2 = (TaskHost)package.Executables.Add("STOCK:SendMailTask");
            taskH2.FailPackageOnFailure = false;
            taskH2.FailParentOnFailure = false;
            Console.WriteLine("SendMailTask: {0}", taskH2.ID);

            package.MaximumErrorCount = 100;
            package.FailPackageOnFailure = false;
            package.FailParentOnFailure = false;
            package.DelayValidation = true;
            package.Execute();

            // Get the collections.
            DtsWarnings dtsWarns = package.Warnings;
            DtsErrors dtsErrs = package.Errors;
            // Use Contains to see if collection can be accessed
            // using item syntax of [x].
            Boolean warnItem = dtsWarns.Contains(0);
            Boolean errItem = dtsErrs.Contains(0);
            
            // If item sytax can be used, use it to obtain information.
            if (warnItem)
            {
            //Using the Item method syntax of [x], obtain the first entry and a description.
            DtsWarning firstWItem = dtsWarns[0];
            String nameOfFirstItem = dtsWarns[0].SubComponent;

            //Print the subcomponent for the warning located at position [0] two ways.
            Console.WriteLine("The first warning subcomponent is: {0}", firstWItem.SubComponent);
            Console.WriteLine("The first warning subcomponent is: {0}", nameOfFirstItem);
            }

            // If item sytax can be used, use it to obtain information.
            if (errItem)
            {
            //Using the Item method syntax of [x], obtain the first entry and a description.
            DtsError firstEItem = dtsErrs[0];
            String nameOfFirstItem = dtsErrs[0].Description;

            //Print the description of the warning located at position [0] two ways.
            Console.WriteLine("The first error description is: {0}", firstEItem.Description);
            Console.WriteLine("The first error description is: {0}", nameOfFirstItem);
            }
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.SendMailTask
 
Namespace Microsoft.SqlServer.SSIS.Samples
    Class Program
        static void Main(string() args)
        {
            Dim package As Package =  New Package() 
            Dim taskH2 As TaskHost = CType(package.Executables.Add("STOCK:SendMailTask"), TaskHost)
            taskH2.FailPackageOnFailure = False
            taskH2.FailParentOnFailure = False
            Console.WriteLine("SendMailTask: {0}", taskH2.ID)
 
            package.MaximumErrorCount = 100
            package.FailPackageOnFailure = False
            package.FailParentOnFailure = False
            package.DelayValidation = True
            package.Execute()
 
            ' Get the collections.
            Dim dtsWarns As DtsWarnings =  package.Warnings 
            Dim dtsErrs As DtsErrors =  package.Errors 
            ' Use Contains to see if collection can be accessed
            ' using item syntax of [x].
            Dim warnItem As Boolean =  dtsWarns.Contains(0) 
            Dim errItem As Boolean =  dtsErrs.Contains(0) 
 
            ' If item sytax can be used, use it to obtain information.
            if (warnItem)
            {
            'Using the Item method syntax of [x], obtain the first entry and a description.
            Dim firstWItem As DtsWarning =  dtsWarns(0) 
            Dim nameOfFirstItem As String =  dtsWarns(0).SubComponent 
 
            'Print the subcomponent for the warning located at position [0] two ways.
            Console.WriteLine("The first warning subcomponent is: {0}", firstWItem.SubComponent)
            Console.WriteLine("The first warning subcomponent is: {0}", nameOfFirstItem)
            }
 
            ' If item sytax can be used, use it to obtain information.
            if (errItem)
            {
            'Using the Item method syntax of [x], obtain the first entry and a description.
            Dim firstEItem As DtsError =  dtsErrs(0) 
            Dim nameOfFirstItem As String =  dtsErrs(0).Description 
 
            'Print the description of the warning located at position [0] two ways.
            Console.WriteLine("The first error description is: {0}", firstEItem.Description)
            Console.WriteLine("The first error description is: {0}", nameOfFirstItem)
            }
        }
    End Class
End Namespace

Sample Output:

SendMailTask: {12ADD307-23DA-42C9-A4B2-E360DEFD7563}

The first warning subcomponent is: Send Mail Task

The first error description is: SMTP Server not specified