IPipeline::Execute

Article
06/07/2013

Ee825933.vb_on(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

HRESULT IPipeline::Execute(longlMode,IDispatch*pdispOrder,IDispatch*pdispContext,longlFlags,long*pErrorLevel);

Parameters

lMode

[in] A long integer 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

[in] A pointer to the IDispatch interface of a Dictionary object, usually an OrderForm object. The Order dictionary that will be used by the pipeline.

pdispContext

[in] A pointer to the IDispatch interface of a Dictionary object. The Context dictionary that will be used by the pipeline.

lFlags

[in] An unused long integer parameter. Must be set to zero (0).

pErrorLevel

[out,retval] A pointer to a long that returns the error level.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT 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, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

In addition, the pErrorLevel parameter is set to 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

The pErrorLevel parameter points to valid data only if the method completes successfully.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.