|
|
| Previous | Next |
The Begin method indicates that progress tracking for an operation is about to begin. An estimate of the duration of the operation is provided when possible.
Syntax
HRESULT Begin(
DWORD dwEstimatedTicks
);
Parameters
dwEstimatedTicks
[in] Double word containing the estimated number of ticks that can be passed during the operation.
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 owning the method that is implementing an operation calls Begin when the operation defined by the method is starting.
The number of ticks passed in dwEstimatedTicks is an estimate of how many times the Progress method will be called during the course of the operation.
Applications can use the estimate information to configure display mechanisms that show progress.
The application returns S_OK to indicate that an operation should be continued and WMDM_E_USER_CANCELLED to indicate that the operation should becancelled. 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
| Previous | Next |