MicroPipe.SetLogFile
.gif "Ee796636.c++_on(en-US,CS.10).gif")
.gif "Ee796636.vb_off(en-US,CS.10).gif")
Use this method to identify the file in which to log the operations of the pipeline component.
Definition
Sub SetLogFile(bstrFileName As String)
Parameters
bstrFileName
A String containing the file name for logging.
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
With logging, the MicroPipe object logs all of the read and write operations of the Dictionary and SimpleList objects. Errors are also recorded in the log. Because of the overhead involved, logging should be used only for debugging and should not be used in a production site.
The SetLogFile method should be called immediately before executing a pipeline. The SetLogFile method is exposed on the OrderGroup object as the LogFile property and should be called again before calling the RunPipe method.
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
pMicroPipeline.SetLogFile("MicroPipeLog.txt")