ExecuteProcess Class

  • Article

Runs an application or batch file as part of a package workflow. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.ExecuteProcess.ExecuteProcess

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

Syntax

'Declaration
<GuidAttribute("6BD3E0BE-DDDE-4305-95D5-5B52C6EEF84F")> _
Public NotInheritable Class ExecuteProcess _
    Inherits Task _
    Implements IDTSExecuteProcess, IDTSComponentPersist
'Usage
Dim instance As ExecuteProcess

[GuidAttribute("6BD3E0BE-DDDE-4305-95D5-5B52C6EEF84F")]
public sealed class ExecuteProcess : Task, 
    IDTSExecuteProcess, IDTSComponentPersist

[GuidAttribute(L"6BD3E0BE-DDDE-4305-95D5-5B52C6EEF84F")]
public ref class ExecuteProcess sealed : public Task, 
    IDTSExecuteProcess, IDTSComponentPersist

[<SealedAttribute>]
[<GuidAttribute("6BD3E0BE-DDDE-4305-95D5-5B52C6EEF84F")>]
type ExecuteProcess =  
    class 
        inherit Task 
        interface IDTSExecuteProcess 
        interface IDTSComponentPersist 
    end

public final class ExecuteProcess extends Task implements IDTSExecuteProcess, IDTSComponentPersist

The ExecuteProcess type exposes the following members.

Constructors

  Name Description
Public method ExecuteProcess Initializes a new instance of the ExecuteProcess class.

Top

Properties

  Name Description
Public property Arguments Gets or sets command prompt arguments. The string can contain multiple arguments separated by a space.
Public property Executable Gets or sets the name of the Microsoft Win32 executable file or batch file to run when the package runs.
Public property ExecutionValue Returns a user-defined object. This property is read-only. (Overrides Task.ExecutionValue.)
Public property FailTaskIfReturnCodeIsNotSuccessValue Gets or sets a Boolean that indicates whether the task fails if the process exit code is different from the value specified in SuccessValue.
Public property RequireFullFileName Gets or sets a Boolean that indicates whether the full name and extension of the task is required.
Public property StandardErrorVariable Gets or sets the name of the variable used to capture the error output of the process to be run.
Public property StandardInputVariable Gets or sets the name of the variable to be used as an input to the process to be run.
Public property StandardOutputVariable Gets or sets the name of the variable used to capture the output of the process to be run.
Public property SuccessValue Gets or sets the value returned by the executable or batch file that indicates success.
Public property TerminateProcessAfterTimeOut Gets or sets a Boolean that indicates whether the process is forced to end after the time-out period specified by the TimeOut property.
Public property TimeOut Gets or sets the number of seconds that the task allows the process to run.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)
Public property WindowStyle Gets or sets the style of the window to run the process in.
Public property WorkingDirectory Gets or sets the directory in which the files specified in the Arguments property can be found.

Top

Methods

  Name Description
Public method CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Public method GetConnectionID Gets a String containing the ID of the connection. (Inherited from Task.)
Public method GetConnectionName Gets a String containing the name of the connection. (Inherited from Task.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method ToString (Inherited from Object.)
Public method Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
Public method Validate Verifies that the component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

Although you can use the ExecuteProcess task to open any standard application, such as Microsoft Excel or Microsoft Word, you typically use it to run business applications or batch files that work against a data source.

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Dts.Tasks.ExecuteProcess Namespace