Windows Media Format SDK banner art
PreviousNext

IWMDMProgress::Progress

The Progress method indicates that an operation is ongoing.

Syntax

HRESULT Progress(
  DWORD  dwTranspiredTicks
);

Parameters

  dwTranspiredTicks

[in]  Double word containing the number of ticks that have transpired so far.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Description
WMDM_E_USER_CANCELLED The application instructs Windows Media Device Manager to cancel the current operation without waiting for it to finish.
E_FAIL An unspecified error occurred.

Remarks

The interface that owns the method that is implementing an operation calls Progress as the operation defined by the method is carried out. The intention is that Progress will be called once per estimated tick. However, the dwTranspiredTicks parameter must be checked on each call because the operation being performed may not guarantee a call once for each estimated tick.

The application returns S_OK to the calling method to indicate that the operation should continue. The application returns WMDM_E_USER_CANCELLED to indicate that the operation should be cancelled. If the application is using block mode and returns WMDM_E_USER_CANCELLED, then Windows Media Device Manager will return this same error to the application.

See Also

PreviousNext


© 1999 Microsoft Corporation. All rights reserved.