Skip to content

Latest commit

 

History

History
141 lines (100 loc) · 3.67 KB

nf-dbgeng-idebugcontrol4-getlogfilewide.md

File metadata and controls

141 lines (100 loc) · 3.67 KB
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.IDebugControl4.GetLogFileWide
IDebugControl4::GetLogFileWide (dbgeng.h)
The GetLogFileWide method returns the name of the currently open log file.
debugger\getlogfilewide.htm
debugger
05/03/2018
IDebugControl4::GetLogFileWide
GetLogFileWide, GetLogFileWide method [Windows Debugging], GetLogFileWide method [Windows Debugging],IDebugControl4 interface, IDebugControl4 interface [Windows Debugging],GetLogFileWide method, IDebugControl4.GetLogFileWide, IDebugControl4::GetLogFileWide, dbgeng/IDebugControl4::GetLogFileWide, debugger.getlogfilewide
dbgeng.h
Dbgeng.h
Desktop
Windows
IDebugControl4::GetLogFileWide
dbgeng/IDebugControl4::GetLogFileWide
APIRef
kbSyntax
COM
dbgeng.h
IDebugControl4::GetLogFileWide

IDebugControl4::GetLogFileWide

-description

The GetLogFileWide 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.

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

-see-also

CloseLogFile

GetLogFile2

GetLogMask

IDebugControl4

OpenLogFile