TaskHost.ExecValueVariable Property

Article
12/03/2008

Gets or sets the custom Variable that contains the execution value of the task.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Property ExecValueVariable As Variable

public Variable ExecValueVariable { get; set; }

public:
property Variable^ ExecValueVariable {
    Variable^ get ();
    void set (Variable^ value);
}

/** @property */
public Variable get_ExecValueVariable ()

/** @property */
public void set_ExecValueVariable (Variable value)

public function get ExecValueVariable () : Variable

public function set ExecValueVariable (value : Variable)

Property Value

A custom Variable that contains the execution value.

Remarks

The name of the custom variable that contains the execution value for the task. The default value of this property is none, which indicates that the result is not set to a variable in the package.

A task can use the ExecutionValue property to provide information about the results of the Execute method. This optional information supplements the Success or Failure status returned by the ExecutionResult property. For example, if a task deletes rows from a table, the task might return the number of rows deleted as the ExecutionValue.

However, to use the ExecutionValue later in the workflow of the package, for example, in a precedence constraint, you must save its value in an existing package variable. You use the ExecValueVariable property to specify the variable that will hold the ExecutionValue.

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

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

Share via