ICcServiceCB::OnProgressNotify
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/27/2008
This method provides the status of the current action to the clients.
This method allows a service to notify clients about the progress of a lengthy operation such as a file download to a device.
Syntax
HRESULT OnProgressNotify(
DWORD dwPreviousState,
DWORD dwCurrentState,
DWORD dwCurrentValue,
DWORD dwMaxValue
);
Parameters
- dwPreviousState
[in] Service state prior to the event of interest.
- dwCurrentState
[in] Current service state.
- dwCurrentValue
[in] Progress indicator. For example, dwCurrentValue could be the number of bytes transferred so far.
- dwMaxValue
[in] Maximum range for the progress. For example, dwMaxValue could be the maximum number of bytes to transfer.
Return Value
The following table shows return values for this method.
| Value | Description |
|---|---|
S_OK |
Indicates success. |
E_FAIL |
Indicates failure. If clients return E_FAIL, the service does not call back into the client with status again. |
Requirements
| Header | ccservicecb.h |
| Windows Embedded CE | Windows CE 5.0 and later |