IBindStatusCallback::OnProgress Method

---

Indicates the current progress of the bind operation.

Syntax

HRESULT OnProgress(
    ULONG  ulProgress,
    ULONG  ulProgressMax,
    ULONG  ulStatusCode,
    LPCWSTR  szStatusText
);

Parameters

ulProgress

[in] Unsigned long integer that contains the current progress of the bind operation relative to the expected maximum indicated in the ulProgressMax parameter.

ulProgressMax

[in] Unsigned long integer that contains the expected maximum value of the ulProgress parameter for the duration of calls to IBindStatusCallback::OnProgress for this bind operation. Note that this value might change across calls to this method. A value of zero means that the maximum value of ulProgress is unknown (for example, in the IMoniker::BindToStorage method when the data download size is unknown).

ulStatusCode

[in] Unsigned long integer that contains additional information regarding the progress of the bind operation. Valid values are taken from the BINDSTATUS enumeration and include:

BINDSTATUS_BEGINDOWNLOADCOMPONENTS	The download operation has begun downloading code for COM components that will be installed before the object can be instantiated. The szStatusText parameter accompanying IBindStatusCallback::OnProgress provides the display name of the component being downloaded.
BINDSTATUS_INSTALLINGCOMPONENTS	The download operation has downloaded code and is installing it. The szStatusText parameter accompanying IBindStatusCallback::OnProgress provides the display name of the component being installed.
BINDSTATUS_ENDDOWNLOADCOMPONENTS	The download operation has finished downloading and installing all the necessary code. The szStatusText parameter accompanying IBindStatusCallback::OnProgress provides the display name of the newly installed component.

szStatusText

[in] Address of a string value that contains the textual information indicating the current progress of the bind operation. The text reflects the BINDSTATUS value of the ulStatusCode parameter and is appropriate for display in the user interface of the client.

Return Value

Returns S_OK if successful, or E_INVALIDARG if one or more parameters are invalid.

Remarks

The moniker calls this method repeatedly to indicate the current progress of the bind operation, typically at reasonable intervals during a lengthy operation.

The client can use the progress notification to provide progress information to the user from the ulProgress, ulProgressMax, and szStatusText parameters, or to make programmatic decisions based on the ulStatusCode parameter.

Client applications that implement the IBindStatusCallback interface can return E_UNIMPL or S_OK if they are not interested in receiving this notification.

Windows CE

Windows CE	Use version 2.12 and later
Minimum availability	Internet Explorer 4.0