ScriptObjectModel Class

Article
04/26/2013

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.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class ScriptObjectModel
'Usage
Dim instance As ScriptObjectModel

public class ScriptObjectModel

public ref class ScriptObjectModel

type ScriptObjectModel =  class end

public class ScriptObjectModel

The ScriptObjectModel type exposes the following members.

Properties

	Name	Description
	Connections	Returns the Connections collection of existing connections defined in the package that contains the Script task.
	Events	Returns the IDTSComponentEvents collection of existing events defined in the package that contains the Script task.
	ExecutionValue	Gets or sets a user-defined object that provides additional information about the results of task execution.
	TaskResult	Returns the DTSExecResult of the Script task.
	Transaction	Returns the transaction associated with the container of the Script task.
	VariableDispenser	Returns the VariableDispenser that can be used within the Script task to work with existing variables.
	Variables	Returns the Variables collection of existing variables defined in the package that contains the Script task.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Log	Logs an entry to all enabled log providers.
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

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.

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

Thread Safety

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

Share via