MicroPipe.SetComponent

Ee783951.c++_on(en-US,CS.10).gifEe783951.vb_off(en-US,CS.10).gif

Use this method to specify the pipeline component to run.

Definition

Sub SetComponent(pdispComponent As Object)

Parameters

pdispComponent

A reference to the pipeline component to be run.

Return Values

None.

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.

Remarks

A single MicroPipe object can be used to execute multiple components. Calling the SetComponent method on the MicroPipe object after setting and executing a different component earlier is permitted. In this case, the MicroPipe object releases the earlier component and sets up the new component in its place.

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
' oCompPipe is an object that references the pipeline component
' to be run.

pMicropipeline.SetComponent(oCompPipe)

See Also

MicroPipe Object

MicroPipe.Execute

MicroPipe.SetLogFile


All rights reserved.