IMicroPipeline::SetLogFile
.gif "Ee825644.c++_off(en-US,CS.10).gif")
.gif "Ee825644.vb_on(en-US,CS.10).gif")
Use this method to identify the file in which to log the operations of the pipeline component.
Definition
HRESULT IMicroPipeline::SetLogFile(BSTRbstrFileName);
Parameters
bstrFileName
[in] A BSTR containing the file name for logging.
Return Values
This method returns an HRESULT indicating whether 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
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.