IControlProgressHandler

  • Article

This interface is a client-side handler that receives updates when the library performs an operation. The library then executes synchronous callbacks to the client indicating the progress of the operation. Depending on the user action, the client return code instructs the library either to continue the operation or else to cancel it. This process enables the UI to show the user the progress of long operations such as Save. If the user chooses to cancel the operation, the UI returns the corresponding code to the library.

Syntax

{
  [id(1), helpstring("OnBegin")] HRESULT OnBegin();
  [id(2), helpstring("OnUpdate")] HRESULT OnUpdate
    ([in] ULONG CurrentValuePercent);
  [id(3), helpstring("OnEnd")] HRESULT OnEnd
    ([in] HRESULT hrResult);
};

Functions

The following table describes the functions that this interface provides.

Function Description

OnBegin

Instructs the library to begin an operation.

OnUpdate

Instructs the library to continue progress of an operation.

OnEnd

Returns a status code after the end of an operation.

Interfaces