IDebugControl2::GetLogFile メソッド (dbgeng.h)
GetLogFile メソッドは、現在開いているログ ファイルの名前を返します。
構文
HRESULT GetLogFile(
[out, optional] PSTR Buffer,
[in] ULONG BufferSize,
[out, optional] PULONG FileSize,
[out] PBOOL Append
);
パラメーター
[out, optional] Buffer
現在開いているログ ファイルの名前を受け取ります。 Buffer が NULL の場合、この情報は返されません。
[in] BufferSize
バッファー バッファーのサイズを文字単位で指定します。
[out, optional] FileSize
ログ ファイルの名前のサイズ (文字単位) を受け取ります。 FileSize が NULL の場合、この情報は返されません。
[out] Append
ログ メッセージがログ ファイルに追加される場合は TRUE 、ファイルを開いたときにログ ファイルの内容が破棄された場合は FALSE を 受け取ります。
戻り値
このメソッドは、エラー値を返すこともできます。 詳細については、「 戻り値 」を参照してください。
リターン コード | 説明 |
---|---|
|
メソッドは正常に実行されました。 |
|
メソッドは正常に実行されました。 ただし、ログ ファイルの名前が バッファー バッファーに 収まらないため、名前が切り捨てられました。 |
|
現在開いているログ ファイルはありません。 |
注釈
GetLogFile と GetLogFileWide は、GetLogFile2 および GetLogFile2Wide と同じように動作し、Append は DEBUG_LOG_APPEND フラグに関する情報のみを受信します。
ログ ファイルの詳細については、「 入力と出力の使用」を参照してください。
要件
要件 | 値 |
---|---|
対象プラットフォーム | デスクトップ |
Header | dbgeng.h (Dbgeng.h を含む) |