ScriptObjectModel 类

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.

继承层次结构

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

命名空间:  Microsoft.SqlServer.Dts.Tasks.ScriptTask
程序集:  Microsoft.SqlServer.ScriptTask(在 Microsoft.SqlServer.ScriptTask.dll 中)

语法

声明
Public Class ScriptObjectModel
用法
Dim instance As ScriptObjectModel
public class ScriptObjectModel
public ref class ScriptObjectModel
type ScriptObjectModel =  class end
public class ScriptObjectModel

ScriptObjectModel 类型公开以下成员。

属性

  名称 说明
公共属性 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.

页首

方法

  名称 说明
公共方法 Equals (从 Object 继承。)
受保护方法 Finalize (从 Object 继承。)
公共方法 GetHashCode (从 Object 继承。)
公共方法 GetType (从 Object 继承。)
公共方法 Log Logs an entry to all enabled log providers.
受保护方法 MemberwiseClone (从 Object 继承。)
公共方法 ToString (从 Object 继承。)

页首

注释

Within the Microsoft Visual Studio 2008 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 使用脚本任务查询 Active Directory.

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

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。