IMicroPipeline::Execute Method [C++]

  • Article

Use this method to run the pipeline component specified by the SetComponent method.

Definition

[C++]

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

[Visual Basic]

Function Execute(pdispOrder As Object,
  pdispContext As Object,
  lFlags As Long) As Long

Parameters

  • pdispOrder[C++]
    [in] A pointer to the IDispatch interface of a Dictionary object. The Dictionary object is the Order dictionary that the pipeline component will run.
  • pdispOrder[Visual Basic]
    A reference to a Dictionary object, usually an OrderForm object. The Order dictionary for the pipeline component to be run.
  • pdispContext[C++]
    [in] A pointer to the IDispatch interface of a Dictionary object. The Context dictionary for the pipeline component to be run.
  • pdispContext[Visual Basic]
    A reference to a Dictionary object. The Context dictionary for the pipeline component to be run.
  • lFlags[C++]
    [in] A long integer. Reserved for future use. Must be set to zero (0).
  • lFlags[Visual Basic]
    A Long integer. Reserved for future use. Must be set to zero (0).
  • pErrorLevel[C++]
    [out,retval] A pointer to a long that returns the error level.

Return Values

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

[Visual Basic] 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

[C++] This method returns the message 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.

[Visual Basic] 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.

[C++] In addition, the pErrorLevel parameter is set to one of the following three values:

[Visual Basic] In addition, the method returns one of the following three values:

Value Description
1 Success. The pipeline component ran successfully.
2 Warning. Generally, these are basket or user errors that would be reported to the user through the ASP page.
3+ Failure. The pipeline component failed to run.

Remarks

[Visual Basic]

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.

[C++]

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

Be sure to release the IMicroPipeline interface when finished.

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

[Visual Basic]

Example

' pMicroPipeline is a Commerce.MicroPipeline object
' dOrder and dContext are Commerce.Dictionary objects

errVal = pMicropipeline.Execute(dOrder, dContext, 0)

See Also

[C++]MicroPipe Object

[Visual Basic]MicroPipe Object

[C++]IMicroPipeline::SetComponent

[Visual Basic]MicroPipe.SetComponent

[C++]IMicroPipeline::SetLogFile

[Visual Basic]MicroPipe.SetLogFile

Copyright © 2005 Microsoft Corporation.
All rights reserved.