ScriptObjectModel Class

ScriptObjectModel Class

 

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.

Namespace:   Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly:  Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)

System.Object
  Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptObjectModel

public class ScriptObjectModel

NameDescription
System_CAPS_pubpropertyConnections

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

System_CAPS_pubpropertyEvents

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

System_CAPS_pubpropertyExecutionValue

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

System_CAPS_pubpropertyTaskResult

Returns the DTSExecResult of the Script task.

System_CAPS_pubpropertyTransaction

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

System_CAPS_pubpropertyVariableDispenser

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

System_CAPS_pubpropertyVariables

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLog(String, Int32, Byte[])

Logs an entry to all enabled log providers.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft