Share via


Execute Method

Signature for the Execute method for executing a COM pipeline.

Namespace:  Microsoft.CommerceServer.Runtime.Pipelines
Assembly:  Microsoft.CommerceServer.Runtime (in Microsoft.CommerceServer.Runtime.dll)

Syntax

'Declaration
Public MustOverride Function Execute ( _
    pipelineDictionary As Object, _
    contextDictionary As Object _
) As Integer
'Usage
Dim instance As PipelineBase
Dim pipelineDictionary As Object
Dim contextDictionary As Object
Dim returnValue As Integer

returnValue = instance.Execute(pipelineDictionary, _
    contextDictionary)
public abstract int Execute(
    Object pipelineDictionary,
    Object contextDictionary
)
public:
virtual int Execute(
    Object^ pipelineDictionary, 
    Object^ contextDictionary
) abstract
public abstract function Execute(
    pipelineDictionary : Object, 
    contextDictionary : Object
) : int

Parameters

  • pipelineDictionary
    Type: System..::.Object
    The read-write pipeline Microsoft.CommerceServer.Runtime.DictionaryClass passed as the "order" parameter to COM pipeline component Execute methods.
  • contextDictionary
    Type: System..::.Object
    The context Microsoft.CommerceServer.Runtime.DictionaryClass passed as the "context" parameter to COM pipeline component Execute methods.

Return Value

Type: System..::.Int32
Error level code. See table in Remarks.

Remarks

Use this method to run a pipeline. This method must be overridden in the derived classes.

Returns an error level code from the pipeline execution, one of the following:

Value

Description

0

Success: The pipeline ran successfully.

1

Warning: A pipeline component raised a warning. Generally, these are basket or user errors that would be reported to the user through a web page.

2

Failure: A pipeline component failed.

Permissions

See Also

Reference

PipelineBase Class

PipelineBase Members

Microsoft.CommerceServer.Runtime.Pipelines Namespace