IDebugControl4::GetLogFileWide method (dbgeng.h)

The GetLogFileWide method returns the name of the currently open log file.

Syntax

HRESULT GetLogFileWide(
  [out, optional] PWSTR  Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG FileSize,
  [out]           PBOOL  Append
);

Parameters

[out, optional] Buffer

Receives the name of the currently open log file. If Buffer is NULL, this information is not returned.

[in] BufferSize

Specifies the size, in characters, of the Buffer buffer.

[out, optional] FileSize

Receives the size, in characters, of the name of the log file. If FileSize is NULL, this information is not returned.

[out] Append

Receives TRUE if log messages are appended to the log file, or FALSE if the contents of the log file were discarded when the file was opened.

Return value

This method can also return error values. See Return Values for more details.

Return code	Description
S_OK	The method was successful.
S_FALSE	The method was successful. However, the name of the log file was too long to fit in the Buffer buffer so the name was truncated.
E_NOINTERFACE	There is no currently open log file.

Remarks

GetLogFile and GetLogFileWide behave the same way as GetLogFile2 and GetLogFile2Wide with Append receiving only the information about the DEBUG_LOG_APPEND flag.

For more information about log files, see Using Input and Output.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)

See also

CloseLogFile

GetLogFile2

GetLogMask

IDebugControl4

OpenLogFile