IOrderPipeline::LoadPipe Method [C++]

Article
11/12/2009

Use this method to load a pipeline configuration file (.pcf) into the pipeline.

Definition

[C++]

HRESULT IOrderPipeline::LoadPipe(BSTRpszFileName);

[Visual Basic]

Sub LoadPipe(pszFileName As String)

Parameters

pszFileName[C++]
[in] A BSTR containing the pipeline configuration file name.
pszFileName[Visual Basic]
A String containing the pipeline configuration file name.

Return Values

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

[Visual Basic] None.

Error Values

[C++] 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.

[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.

Remarks

The LoadPipe method must be called to initialize all pipelines.

The LoadPipe method fails if you attempt to load a pipeline configuration file designated for transactions (for use with the MtsTxPipeline or PooledTxPipeline objects).

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

[Visual Basic]

Example

' pOrdPipeline is a Commerce.OrderPipeline object.

errVal = pOrdPipeline.Load("CustomShip.pcf")

Share via