Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ExecuteProcess Class

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

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)
[GuidAttribute("730F5F89-3336-4568-B2D1-7E8A26E2796F")]
public sealed class ExecuteProcess : Task, 
	IDTSExecuteProcess, IDTSComponentPersist

The ExecuteProcess type exposes the following members.

  NameDescription
Public methodExecuteProcessInitializes a new instance of the ExecuteProcess class.
Top
  NameDescription
Public propertyArgumentsGets or sets command prompt arguments. The string can contain multiple arguments separated by a space.
Public propertyExecutableGets or sets the name of the Microsoft Win32 executable file or batch file to run when the package runs.
Public propertyExecutionValueReturns a user-defined object. This property is read-only. (Overrides Task.ExecutionValue.)
Public propertyFailTaskIfReturnCodeIsNotSuccessValueGets or sets a Boolean that indicates whether the task fails if the process exit code is different from the value specified in SuccessValue.
Public propertyRequireFullFileNameGets or sets a Boolean that indicates whether the full name and extension of the task is required.
Public propertyStandardErrorVariableGets or sets the name of the variable used to capture the error output of the process to be run.
Public propertyStandardInputVariableGets or sets the name of the variable to be used as an input to the process to be run.
Public propertyStandardOutputVariableGets or sets the name of the variable used to capture the output of the process to be run.
Public propertySuccessValueGets or sets the value returned by the executable or batch file that indicates success.
Public propertyTerminateProcessAfterTimeOutGets or sets a Boolean that indicates whether the process is forced to end after the time-out period specified by the TimeOut property.
Public propertyTimeOutGets or sets the number of seconds that the task allows the process to run.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)
Public propertyWindowStyleGets or sets the style of the window to run the process in.
Public propertyWorkingDirectoryGets or sets the directory in which the files specified in the Arguments property can be found.
Top
  NameDescription
Public methodCanUpdate*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteRuns the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected methodFinalize (Inherited from Object.)
Public methodGetConnectionIDGets a String containing the ID of the connection. (Inherited from Task.)
Public methodGetConnectionNameGets a String containing the name of the connection. (Inherited from Task.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeTaskInitializes 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 methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public methodToString (Inherited from Object.)
Public methodUpdate*** 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 methodValidateVerifies that the component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.