IBindStatusCallback::OnProgress

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method indicates the 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 during calls to IBindStatusCallback::OnProgress for this bind operation. Be aware 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 receives additional information about the progress of the bind operation. This can be any of the BINDSTATUS values.

• szStatusText
  [in] Address of a string value that contains the textual information that indicates 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 this is 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 do not have to receive this notification.

Requirements

See Also

Reference

URL Moniker Services Interfaces