IDebugControl::GetLogFile method

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

Syntax


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

Parameters

Buffer [out, optional]

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

BufferSize [in]

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

FileSize [out, optional]

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

Append [out]

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 codeDescription
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

Target platform

Desktop

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugControl
IDebugControl2
IDebugControl3
OpenLogFile
GetLogFile2
CloseLogFile
GetLogMask

 

 

Send comments about this topic to Microsoft

Show: