ScriptObjectModel.ExecutionValue Property

Article
12/03/2008

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

public Object ExecutionValue { get; set; }

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

/** @property */
public Object get_ExecutionValue ()

/** @property */
public void set_ExecutionValue (Object value)

public function get ExecutionValue () : Object

public function set ExecutionValue (value : Object)

Property Value

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 as a value from the corresponding member of the ScriptObjectModel.Results enumeration.

Example

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

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms