MicroPipe.Execute
.gif "Ee796513.c++_on(en-US,CS.10).gif")
.gif "Ee796513.vb_off(en-US,CS.10).gif")
Use this method to run the pipeline component specified by the SetComponent method.
Definition
Function Execute(pdispOrder As Object,pdispContext As Object,lFlags As Long) As Long
Parameters
pdispOrder
A reference to a Dictionary object, usually an OrderForm object. The Order dictionary for the pipeline component to be run.
pdispContext
A reference to a Dictionary object. The Context dictionary for the pipeline component to be run.
lFlags
A Long integer. Reserved for future use. Must be set to zero (0).
Return Values
If this method completes successfully, it returns a Long integer indicating whether there were warnings or errors detected by the component. 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 component ran successfully. |
| 2 | The pipeline component raised a warning. Generally, these are basket or user errors that would be reported to the user through the ASP page. |
| 3 | The pipeline component failed to run. |
Remarks
After the script has used the MicroPipe object, it should release the object by assigning Nothing to the object reference.
For more information about programming with pipeline objects, including code samples, see Pipeline Objects.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
Example
' pMicroPipeline is a Commerce.MicroPipeline object
' dOrder and dContext are Commerce.Dictionary objects
errVal = pMicropipeline.Execute(dOrder, dContext, 0)