_OrderGroup::get_LogFile, put_LogFile
.gif "Ee811412.c++_off(en-US,CS.10).gif")
.gif "Ee811412.vb_on(en-US,CS.10).gif")
The LogFile property is a read/write String that specifies the file name used for pipeline logging during the execution of the RunPipe method.
Definition
Get method:
HRESULT _OrderGroup::get_LogFile(BSTR*LogFile);
Put method:
HRESULT _OrderGroup::put_LogFile(BSTRLogFile);
Parameters
LogFile
[in] When putting the property, a BSTR that contains the log file.
[out, retval] When getting the property, a pointer to a BSTR used to return the log file.
Return Values
These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.
Error Values
These methods return 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
The LogFile parameter contains valid data only if the property is accessed successfully.
Set the LogFile parameter to an empty string ("") to disable logging.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.