IMicroPipeline::SetComponent

Ee825503.c++_off(en-US,CS.10).gifEe825503.vb_on(en-US,CS.10).gif

Use this method to specify the pipeline component to run.

Definition

HRESULT IMicroPipeline::SetComponent(IDispatch*pdispComponent);

Parameters

pdispComponent

[in] A pointer to the IDispatch interface of the pipeline component to be run.

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.

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.

See Also

MicroPipe Object

IMicroPipeline::Execute

IMicroPipeline::SetLogFile


All rights reserved.