Partager via


Propriété ExecutionValue

Returns a user-defined object. This property is read-only.

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

Syntaxe

'Déclaration
Public Overrides ReadOnly Property ExecutionValue As Object
    Get
'Utilisation
Dim instance As FtpTask
Dim value As Object

value = instance.ExecutionValue
public override Object ExecutionValue { get; }
public:
virtual property Object^ ExecutionValue {
    Object^ get () override;
}
abstract ExecutionValue : Object
override ExecutionValue : Object
override function get ExecutionValue () : Object

Valeur de propriété

Type : System. . :: . .Object
A user-defined object.

Notes

The ExecutionValue property of the task is a read-only object property that enables the task to expose information regarding the results of its execution, post messages, or return the DTSExecResult return value. For example, if a task deletes rows from a table as part of its Execute method, it might return the number of rows deleted as the ExecutionValue. Clients of the task could then use this value to establish precedence constraints between tasks.

Tasks override the base implementation of the ExecutionValue property, and override the value that is set by the task during its Execute method.

Exemples

The following code example creates an FtpTask, then shows the default values it contains after creation. Some fields are empty, and must be explicitly set before the task is executed in the package.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.FtpTask;

namespace FTPTask
{
    class Program
    {
        static void Main(string[] args)
        {
            Package pkg = new Package();
            Executable exec1 = pkg.Executables.Add("STOCK:FTPTask");
            TaskHost th = exec1 as TaskHost;

            // List the default values of the FTP task
            // using the Properties collection of the TaskHost.
            Console.WriteLine("Connection           {0}", th.Properties["Connection"].GetValue(th));
            Console.WriteLine("DebugMode            {0}", th.Properties["DebugMode"].GetValue(th));
            Console.WriteLine("ExecutionValue       {0}", th.Properties["ExecutionValue"].GetValue(th));
            Console.WriteLine("IsLocalPathVariable  {0}", th.Properties["IsLocalPathVariable"].GetValue(th));
            Console.WriteLine("IsRemotePathVariable {0}", th.Properties["IsRemotePathVariable"].GetValue(th));
            Console.WriteLine("IsTransferTypeASCII  {0}", th.Properties["IsTransferTypeASCII"].GetValue(th));
            Console.WriteLine("LocalPath            {0}", th.Properties["LocalPath"].GetValue(th));
            Console.WriteLine("Operation            {0}", th.Properties["Operation"].GetValue(th));
            Console.WriteLine("OperationName        {0}", th.Properties["OperationName"].GetValue(th));
            Console.WriteLine("OverwriteDestination {0}", th.Properties["OverwriteDestination"].GetValue(th));
            Console.WriteLine("RemotePath           {0}", th.Properties["RemotePath"].GetValue(th));
            Console.WriteLine("StopOnOperationFailure  {0}", th.Properties["StopOnOperationFailure"].GetValue(th));
            Console.WriteLine("SuspendRequired      {0}", th.Properties["SuspendRequired"].GetValue(th));

            Console.WriteLine("--------------------------");
            // Show how to set a property using the TaskHost Properties.
            th.Properties["Operation"].SetValue(th, DTSFTPOp.Receive);
            Console.WriteLine("New value of Operation:  {0}", th.Properties["Operation"].GetValue(th));
        }
    }
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.FtpTask
 
Namespace FTPTask
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim pkg As Package =  New Package() 
            Dim exec1 As Executable =  pkg.Executables.Add("STOCK:FTPTask") 
            Dim th As TaskHost =  exec1 as TaskHost 

            ' List the default values of the FTP task
            ' using the Properties collection of the TaskHost.
            Console.WriteLine("Connection           {0}", th.Properties("Connection").GetValue(th))
            Console.WriteLine("DebugMode            {0}", th.Properties("DebugMode").GetValue(th))
            Console.WriteLine("ExecutionValue       {0}", th.Properties("ExecutionValue").GetValue(th))
            Console.WriteLine("IsLocalPathVariable  {0}", th.Properties("IsLocalPathVariable").GetValue(th))
            Console.WriteLine("IsRemotePathVariable {0}", th.Properties("IsRemotePathVariable").GetValue(th))
            Console.WriteLine("IsTransferTypeASCII  {0}", th.Properties("IsTransferTypeASCII").GetValue(th))
            Console.WriteLine("LocalPath            {0}", th.Properties("LocalPath").GetValue(th))
            Console.WriteLine("Operation            {0}", th.Properties("Operation").GetValue(th))
            Console.WriteLine("OperationName        {0}", th.Properties("OperationName").GetValue(th))
            Console.WriteLine("OverwriteDestination {0}", th.Properties("OverwriteDestination").GetValue(th))
            Console.WriteLine("RemotePath           {0}", th.Properties("RemotePath").GetValue(th))
            Console.WriteLine("StopOnOperationFailure  {0}", th.Properties("StopOnOperationFailure").GetValue(th))
            Console.WriteLine("SuspendRequired      {0}", th.Properties("SuspendRequired").GetValue(th))
 
            Console.WriteLine("--------------------------")
            ' Show how to set a property using the TaskHost Properties.
            th.Properties("Operation").SetValue(th, DTSFTPOp.Receive)
            Console.WriteLine("New value of Operation:  {0}", th.Properties("Operation").GetValue(th))
        End Sub
    End Class
End Namespace

Sample Output:

Connection

DebugMode False

ExecutionValue 0

IsLocalPathVariable False

IsRemotePathVariable False

IsTransferTypeASCII False

LocalPath

Operation 0

OperationName

OverwriteDestination False

RemotePath

StopOnOperationFailure True

SuspendRequired False

--------------------------

New value of Operation: 1