Share via


IGraphBuilder::SetLogFile (Compact 2013)

3/26/2014

This method sets the file into which actions taken in attempting to perform an operation are logged.

Syntax

HRESULT SetLogFile(
  HANDLE hFile
);

Parameters

  • hFile
    [in] Handle to the log file.

Return Value

Returns an HRESULT value that depends on the implementation. HRESULT can be one of the standard constants listed in the following table, or other values not listed.

Value

Description

E_FAIL

The method was unsuccessful.

E_POINTER

The hFile parameter is a Null pointer.

E_INVALIDARG

The hFile parameter is not valid.

E_NOTIMPL

The method is not supported.

S_OK

The method was successful.

NOERROR

The method was successful.

Remarks

Before you close the file handle, call IGraphBuilder::SetLogFile with a NULL file handle.

Note

To enable logging with IGraphBuilder::SetLogFile, you must add the DirectShow Error Messages catalog item (SYSGEN_DSHOW_ERRORS) to your OS design.

The hFile parameter must be an open file handle. After you call this method with a valid file handle, actions taken by IGraphBuilder methods when attempting to build a filter graph are logged to this file. This is intended to help you determine the cause of any failure to automatically build a filter graph.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IGraphBuilder Interface

Other Resources

CreateFile