ScriptObjectModel ScriptObjectModel ScriptObjectModel Class

Definition

Gives the developer of the Script task programmatic access to objects defined in the package through the global Dts object. The Dts object is an instance of the ScriptObjectModel class.

public ref class ScriptObjectModel
public class ScriptObjectModel
Public Class ScriptObjectModel
Inheritance
ScriptObjectModelScriptObjectModelScriptObjectModel

Examples

The following sample of code for use inside a Script task demonstrates the use of the Variables, Events, and TaskResult properties. For more information, see Querying the Active Directory with the Script Task.

Public Sub Main()  
  
    Dim directory As DirectoryServices.DirectorySearcher  
    Dim result As DirectoryServices.SearchResult  
    Dim email As String  
  
    email = Dts.Variables("email").Value.ToString  
  
    Try  
        directory = New _  
            DirectoryServices.DirectorySearcher("(mail=" & email & ")")  
        result = directory.FindOne  
        Dts.Variables("name").Value = _  
            result.Properties("displayname").ToString  
        Dts.Variables("title").Value = _  
            result.Properties("title").ToString  
        Dts.TaskResult = ScriptResults.Success  
    Catch ex As Exception  
        Dts.Events.FireError(0, _  
            "Script Task Example", _  
            ex.Message & ControlChars.CrLf & ex.StackTrace, _  
            String.Empty, 0)  
        Dts.TaskResult = ScriptResults.Failure  
    End Try  
  
End Sub  

Remarks

Within the Microsoft Visual Studio Tools for Applications (VSTA) scripting environment, the Script task provides the global Dts object, which gives the developer programmatic access to objects defined elsewhere in the package, such as connections, variables, and events, through the properties and methods of the ScriptObjectModel class. The Dts object is an instance of the ScriptObjectModel class.

Properties

Connections Connections Connections

Returns the Connections collection of existing connections defined in the package that contains the Script task.

Events Events Events

Returns the IDTSComponentEvents collection of existing events defined in the package that contains the Script task.

ExecutionValue ExecutionValue ExecutionValue

Gets or sets a user-defined object that provides additional information about the results of task execution.

TaskResult TaskResult TaskResult

Returns the DTSExecResult of the Script task.

Transaction Transaction Transaction

Returns the transaction associated with the container of the Script task.

VariableDispenser VariableDispenser VariableDispenser

Returns the VariableDispenser that can be used within the Script task to work with existing variables.

Variables Variables Variables

Returns the Variables collection of existing variables defined in the package that contains the Script task.

Methods

Log(String, Int32, Byte[]) Log(String, Int32, Byte[]) Log(String, Int32, Byte[])

Logs an entry to all enabled log providers.

Applies to