Classe ScriptObjectModel

Article
04/27/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.

Hiérarchie d'héritage

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

Espace de noms : Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly : Microsoft.SqlServer.ScriptTask (en Microsoft.SqlServer.ScriptTask.dll)

Syntaxe

'Déclaration
Public Class ScriptObjectModel
'Utilisation
Dim instance As ScriptObjectModel

public class ScriptObjectModel

public ref class ScriptObjectModel

type ScriptObjectModel =  class end

public class ScriptObjectModel

Le type ScriptObjectModel expose les membres suivants.

Propriétés

	Nom	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.

Haut de la page

Méthodes

	Nom	Description
	Equals	(hérité de Object.)
	Finalize	(hérité de Object.)
	GetHashCode	(hérité de Object.)
	GetType	(hérité de Object.)
	Log	Logs an entry to all enabled log providers.
	MemberwiseClone	(hérité de Object.)
	ToString	(hérité de Object.)

Haut de la page

Notes

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.

Exemples

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 Interrogation d'Active Directory avec la tâche de script.

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Dts.Tasks.ScriptTask

Partager via