• Article

LogEntryInfos.Add Method

Adds a new LogEntryInfo object to the LogEntryInfos collection.

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

Syntax

'Declaration
Public Sub Add ( _
    name As String, _
    description As String, _
    frequencyHint As DTSLogEntryFrequency _
)
'Usage
Dim instance As LogEntryInfos
Dim name As String
Dim description As String
Dim frequencyHint As DTSLogEntryFrequency

instance.Add(name, description, frequencyHint)

public void Add(
    string name,
    string description,
    DTSLogEntryFrequency frequencyHint
)

public:
void Add(
    String^ name, 
    String^ description, 
    DTSLogEntryFrequency frequencyHint
)

member Add : 
        name:string * 
        description:string * 
        frequencyHint:DTSLogEntryFrequency -> unit 

public function Add(
    name : String, 
    description : String, 
    frequencyHint : DTSLogEntryFrequency
)

Parameters

  • name
    Type: System.String
    The name of the log entry to add to the collection.
  • description
    Type: System.String
    A description for the log entry.

Examples

The following code sample adds a log entry to the collection.

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

namespace LogEntryInfosTest
{
    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);

            // Get the LogEntryInfos from the package.
            LogEntryInfos logInfos = pkg.LogEntryInfos;

            //Note how many log entries exist before adding one.
            String countLEI = logInfos.Count.ToString();
            Console.WriteLine("Entries at beginning: {0}", countLEI);
 
            String newName = "My new log entry info";
            String newDesc = "My new Description";
            DTSLogEntryFrequency newFreq = DTSLogEntryFrequency.Consistent;
            logInfos.Add(newName, newDesc, newFreq);

            //Note how many log entries exist after adding one.
            countLEI = logInfos.Count.ToString();
            Console.WriteLine("Entries after adding one: {0}", countLEI);

            //Now remove the entry just added.
            logInfos.Remove("My new log entry info");
            countLEI = logInfos.Count.ToString();
            Console.WriteLine("Entries after Remove: {0}", countLEI);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace LogEnTryInfosTest
    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) 
 
            ' Get the LogEntryInfos from the package.
            Dim logInfos As LogEnTryInfos =  pkg.LogEnTryInfos 
 
            'Note how many log entries exist before adding one.
            Dim countLEI As String =  logInfos.Count.ToString() 
            Console.WriteLine("Entries at beginning: {0}", countLEI)
 
            Dim NewName As String =  "My new log entry info" 
            Dim NewDesc As String =  "My new Description" 
            Dim NewFreq As DTSLogEnTryFrequency =  DTSLogEnTryFrequency.Consistent 
            logInfos.Add(NewName, NewDesc, NewFreq)
 
            'Note how many log entries exist after adding one.
            countLEI = logInfos.Count.ToString()
            Console.WriteLine("Entries after adding one: {0}", countLEI)
 
            'Now remove the entry just added.
            logInfos.Remove("My new log entry info")
            countLEI = logInfos.Count.ToString()
            Console.WriteLine("Entries after Remove: {0}", countLEI)
         End Sub
    End Class
End Namespace

Sample Output:

Entries at beginning: 1

Entries after adding one: 2

Entries after Remove: 1