MtsPipeline.Execute
.gif "Ee784545.c++_on(en-US,CS.10).gif")
.gif "Ee784545.vb_off(en-US,CS.10).gif")
Use this method to run the stages in the pipeline configuration file, which was previously specified by the LoadPipe method.
Definition
Function Execute(lMode As Long,pdispOrder As Object,pdispContext As Object,lFlags As Long) As Long
Parameters
lMode
A Long indicating the mode in which to run the pipeline. This parameter is provided only for backward compatibility with Site Server 3.0 Commerce Edition sites. In Site Server 3.0 Commerce Edition and later, the mode is set by loading an appropriately configured pipeline with the LoadPipe method. Use a value of one (1). A value of zero (0) prevents any stages from running.
pdispOrder
A reference to a Dictionary object, usually an OrderForm object. The Order dictionary that will be used by the pipeline.
pdispContext
A reference to a Dictionary object. The Context dictionary that will be used by the pipeline.
lFlags
An unused Long parameter. Must be set to zero (0).
Return Values
If this method completes successfully, it returns a Long indicating whether there were warnings or errors detected by components in the pipeline. See the Error Values section for more details.
Error Values
This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
In addition, the method returns one of the following three values:
| Value | Description |
| 1 | The pipeline ran successfully. |
| 2 | A pipeline component raised a warning. Generally, these are basket or user errors that would be reported to the user through the ASP page. |
| 3 | A pipeline component failed to run. |
Remarks
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
Example
' pMtsPipeline is a Commerce.MtsPipeline object
' dOrder and dContext are Commerce.Dictionary objects
errVal = pMtsPipelineExecute(1, dOrder, dContext, 0)