TaskHost.ExecValueVariable Property


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

 property Microsoft::SqlServer::Dts::Runtime::Variable ^ ExecValueVariable { Microsoft::SqlServer::Dts::Runtime::Variable ^ get(); void set(Microsoft::SqlServer::Dts::Runtime::Variable ^ value); };
[Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "ExecValueVariableDesc")]
public Microsoft.SqlServer.Dts.Runtime.Variable ExecValueVariable { get; set; }
[<Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "ExecValueVariableDesc")>]
member this.ExecValueVariable : Microsoft.SqlServer.Dts.Runtime.Variable with get, set
Public Property ExecValueVariable As Variable

Property Value

A custom Variable that contains the execution results.



The name of the custom variable that contains the execution result 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.

The TaskHost exposes the ExecutionValue property through the ExecValueVariable property. The task uses the ExecutionValue property to provide optional, supplemental information about the results of execution. The ExecValueVariable property allows the user to map the ExecutionValue that the task returns to any variable that is visible to the task. The package could then use the value that is returned as one of the criteria for determining the next task to run in the control flow. For example, if a task deletes rows from a table as part of its Execute method, the task might return the number of rows deleted as the ExecutionValue. Clients of the task could then use this value to define expressions in precedence constraints between tasks.

Applies to