IDebugControl4::GetLogFile2 method (dbgeng.h)

Article
02/22/2024

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

Syntax

HRESULT GetLogFile2(
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG FileSize,
  [out]           PULONG Flags
);

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] Flags

Receives the bit-flags that were used when opening the log file. See the Flags parameter of OpenLogFile2 for a description of these flags.

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

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

Requirements

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