UID

title

description

old-location

tech.root

ms.date

keywords

ms.keywords

req.header

req.include-header

req.target-type

req.target-min-winverclnt

req.target-min-winversvr

req.kmdf-ver

req.umdf-ver

req.ddi-compliance

req.unicode-ansi

req.idl

req.max-support

req.namespace

req.assembly

req.type-library

req.lib

req.dll

req.irql

targetos

req.typenames

f1_keywords

topic_type

api_type

api_location

api_name

NF:dbgeng.IDebugControl2.GetLogFile

IDebugControl2::GetLogFile (dbgeng.h)

Learn about the IDebugControl2::GetLogFile method, which returns the name of the currently open log file.

debugger\getlogfile.htm

debugger

05/03/2018

IDebugControl2::GetLogFile

GetLogFile, GetLogFile method [Windows Debugging], GetLogFile method [Windows Debugging],IDebugControl interface, GetLogFile method [Windows Debugging],IDebugControl2 interface, GetLogFile method [Windows Debugging],IDebugControl3 interface, IDebugControl interface [Windows Debugging],GetLogFile method, IDebugControl2 interface [Windows Debugging],GetLogFile method, IDebugControl2.GetLogFile, IDebugControl2::GetLogFile, IDebugControl3 interface [Windows Debugging],GetLogFile method, IDebugControl3::GetLogFile, IDebugControl::GetLogFile, IDebugControl_cad2fa56-b2ca-4a26-822e-193acf602913.xml, dbgeng/IDebugControl2::GetLogFile, dbgeng/IDebugControl3::GetLogFile, dbgeng/IDebugControl::GetLogFile, debugger.getlogfile

dbgeng.h

Dbgeng.h

Desktop

Windows

IDebugControl2::GetLogFile

dbgeng/IDebugControl2::GetLogFile

APIRef

kbSyntax

COM

dbgeng.h

IDebugControl2::GetLogFile

-description

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

-parameters

-param Buffer [out, optional]

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

-param BufferSize [in]

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

-param FileSize [out, optional]

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

-param 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.

-returns

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.