2.5.2 Steps Collection
The Steps collection is stored as part of the Package object.
The per-item properties of the Steps collection are listed in the following table.
|
Property |
Type |
Description |
|---|---|---|
|
Name |
BSTR |
Specifies the name of the Step object. |
|
TaskName |
BSTR |
Specifies the name of the task to execute. |
|
ActiveXScript |
BSTR |
Specifies the ActiveX script to execute prior to the task. |
|
ScriptLanguage |
BSTR |
Specifies the ActiveX script language (such as Visual Basic Scripting Edition (VBScript), Jscript, or PerlScript). For more information about VBScript, see [MSDN-VBSLR]. For more information about Jscript, see [MSDN-JscriptRef]. For more information about PerlScript, see [PerlScript]. |
|
CommitSuccess |
BOOL |
Specifies whether to commit the Step if it completes successfully. If TRUE, the Step is committed. If FALSE, the Step is not committed. |
|
RollbackFailure |
BOOL |
Specifies whether to roll back the package transaction if the Step fails. If TRUE, the package transaction is rolled back if the Step fails. If FALSE, the package transaction is not rolled back if the Step fails. |
|
CloseConnection |
BOOL |
Specifies whether to close the connection when the Step completes. If TRUE, the connection is closed. If FALSE, the connection is not closed. |
|
RelativePriority |
LONG |
Specifies the relative priority of the thread where the Step runs. For more information, see the RelativePriority property table later in this section. |
|
AddGlobalVariables |
BOOL |
Specifies whether global variables can be accessed. If TRUE, global variables can be accessed. If FALSE, global variables cannot be accessed. |
|
ExecuteInMainThread |
BOOL |
Specifies whether to use the main thread or a worker thread. If TRUE, the main thread is used. If FALSE, the worker thread is used. |
|
IsPackageDSORowset |
BOOL |
Specifies whether the Step returns a rowset (if the containing package is a rowset provider). If TRUE, the Step returns a rowset. If FALSE, the Step does not return a rowset. |
|
JoinTransactionIfPresent |
BOOL |
Specifies whether the Step executes within the package transaction. If TRUE, the Step executes within the package transaction. If FALSE, the Step does not execute within the package transaction. |
|
IsDisabled |
BOOL |
Specifies whether the Step is to be presently disabled. If TRUE, the Step is disabled. If FALSE, the Step is not disabled. |
|
FailPackageOnError |
BOOL |
Specifies whether the package fails if the Step commits an error. If TRUE, the package fails. If FALSE, the package does not fail. |
The RelativePriority property can have one of values that are described in the following table.
|
Name |
Value |
Description |
|---|---|---|
|
Lowest |
0x0001 |
Use Win32 THREAD_PRIORITY_LOWEST. |
|
BelowNormal |
0x0002 |
Use Win32 THREAD_PRIORITY_BELOW_NORMAL. |
|
Normal |
0x0003 |
Use Win32 THREAD_PRIORITY_NORMAL. |
|
AboveNormal |
0x0004 |
Use Win32 THREAD_PRIORITY_ABOVE_NORMAL. |
|
Highest |
0x0005 |
Use Win32 THREAD_PRIORITY_HIGHEST. |
The persistent collection set contains precedence constraints, persisted in a PersistStorage structure that is named "PrecedenceConstraints". Each row of the persistent collection can have the values that are described in the following table.
|
Property |
Type |
Description |
|---|---|---|
|
StepName |
BSTR |
Specifies the name of the Step, the result of which is to be evaluated to determine whether the DTS constraint is satisfied. |
|
PrecedenceBasis |
LONG |
Specifies how to determine whether the DTS constraint is satisfied. For more information, see the PrecedenceBasis property table. |
|
Value |
Specifies the value of the object. |
The PrecedenceBasis property can have one of the values that are described in the following table.
|
Name |
Value |
Description |
|---|---|---|
|
Execute Status |
0x0000 |
Used for comparison with the current Step status. |
|
Execute Result |
0x0001 |
Used for comparison with the completed Step result. |
The value of the execution status (used for comparison) can be one of the values that are described in the following table.
|
Name |
Value |
Description |
|---|---|---|
|
Waiting |
0x0001 |
Specifies that the Step is waiting to execute. |
|
In Progress |
0x0002 |
Specifies that the Step is executing. |
|
Inactive |
0x0003 |
Specifies that the Step is not active. |
|
Completed |
0x0004 |
Specifies that the execution of the Step is complete. |
The value of the execution results (used for comparison) can be one of the values that are described in the following table.
|
Name |
Value |
Description |
|---|---|---|
|
Success |
0x0000 |
Specifies that the Step succeeded. |
|
Failure |
0x0001 |
Specifies that the Step failed. |
|
Retry |
0x0002 |
Not applicable. |