ExecuteProcess Class
Collapse the table of content
Expand the table of content

ExecuteProcess Class

 

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

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

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

[GuidAttribute("B3A79E82-6FC0-49F0-8C94-89D462AFEFF1")]
public sealed class ExecuteProcess : Task, IDTSExecuteProcess, 
	IDTSComponentPersist

NameDescription
System_CAPS_pubmethodExecuteProcess()

Initializes a new instance of the ExecuteProcess class.

NameDescription
System_CAPS_pubpropertyArguments

Gets or sets command prompt arguments. The string can contain multiple arguments separated by a space.

System_CAPS_pubpropertyExecutable

Gets or sets the name of the Microsoft Win32 executable file or batch file to run when the package runs.

System_CAPS_pubpropertyExecutionValue

Returns a user-defined object. This property is read-only.(Overrides Task.ExecutionValue.)

System_CAPS_pubpropertyFailTaskIfReturnCodeIsNotSuccessValue

Gets or sets a Boolean that indicates whether the task fails if the process exit code is different from the value specified in SuccessValue.

System_CAPS_pubpropertyRequireFullFileName

Gets or sets a Boolean that indicates whether the full name and extension of the task is required.

System_CAPS_pubpropertyStandardErrorVariable

Gets or sets the name of the variable used to capture the error output of the process to be run.

System_CAPS_pubpropertyStandardInputVariable

Gets or sets the name of the variable to be used as an input to the process to be run.

System_CAPS_pubpropertyStandardOutputVariable

Gets or sets the name of the variable used to capture the output of the process to be run.

System_CAPS_pubpropertySuccessValue

Gets or sets the value returned by the executable or batch file that indicates success.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyTerminateProcessAfterTimeOut

Gets or sets a Boolean that indicates whether the process is forced to end after the time-out period specified by the TimeOut property.

System_CAPS_pubpropertyTimeOut

Gets or sets the number of seconds that the task allows the process to run.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

System_CAPS_pubpropertyWindowStyle

Gets or sets the style of the window to run the process in.

System_CAPS_pubpropertyWorkingDirectory

Gets or sets the directory in which the files specified in the Arguments property can be found.

NameDescription
System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

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).)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** 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.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the component is properly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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.

Return to top
Show:
© 2016 Microsoft