Share via

  • Article

ScriptObjectModel.ExecutionValue Property

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

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

Syntax

'Declaration
Public Property ExecutionValue As Object
    Get
    Set
'Usage
Dim instance As ScriptObjectModel
Dim value As Object

value = instance.ExecutionValue

instance.ExecutionValue = value

public Object ExecutionValue { get; set; }

public:
property Object^ ExecutionValue {
    Object^ get ();
    void set (Object^ value);
}

member ExecutionValue : Object with get, set

function get ExecutionValue () : Object
function set ExecutionValue (value : Object)

Property Value

Type: System.Object
A user-defined object that provides additional information about the results of task execution.

Remarks

Use the ExecutionValue property of the Dts object in Script task code to return additional user-defined information about the results of task execution.This property gives the developer a way to exchange data with the package in addition to events and the separate DTSExecResult value. For example, if a Script task deletes rows from a table, it might return the number of rows deleted as the ExecutionValue. Subsequent tasks could then use this value to make decisions for additional processing.

The Script task returns its separate DTSExecResult through the TaskResult property.

Examples

The following sample of code for use inside a Script task demonstrates how the ExecutionValue can also be used to determine the path of the workflow.

Dim rowsAffected as Integer
...
rowsAffected = 1000
Dts.ExecutionValue = rowsAffected