IFileSinkFilter2::GetMode method (strmif.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetMode method retrieves whether the file writer destroys the file when it creates the new one.

Syntax

HRESULT GetMode(
  [out] DWORD *pdwFlags
);

Parameters

[out] pdwFlags

Pointer to the retrieved flags. Currently, the only defined flag is AM_FILE_OVERWRITE, which indicates that the file should be destroyed; zero indicates that the file will be left alone.

Return value

Returns an HRESULT value that depends on the implementation of the interface.

Requirements

See also

Error and Success Codes

IFileSinkFilter2 Interface