IAMCopyCaptureFileProgress::Progress method (strmif.h)

Article
07/27/2023

[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 Progress method is called periodically by the ICaptureGraphBuilder2::CopyCaptureFile method while it copies the file.

Syntax

HRESULT Progress(
  [in] int iProgress
);

Parameters

[in] iProgress

Specifies the percentage of the copy operation that has completed, as a value between 0 and 100.

Return value

Returns S_OK or an HRESULT error code.

Remarks

Applications typically use the value of iProgress to update a progress bar on the user interface.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib