DWriteEngine2Events::Update method (imapi2.h)

Implement this method to receive progress notification of the current write operation.

Syntax

HRESULT Update(
  [in] IDispatch *object,
  [in] IDispatch *progress
);

Parameters

[in] object

The IWriteEngine2 interface that initiated the write operation.

This parameter is a MsftWriteEngine2 object in script.

[in] progress

An IWriteEngine2EventArgs interface that you use to determine the progress of the write operation.

This parameter is a MsftWriteEngine2 object in script.

Return value

Return values are ignored.

Remarks

Notifications are sent in response to calling the IWriteEngine2::WriteSection method.

Notification is sent:

  • Once before the operation begins
  • Every 0.5 seconds during the write operation
  • Once after the operation completes
To stop the write process, call the IWriteEngine2::CancelWrite method.

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header imapi2.h

See also

DWriteEngine2Events

IWriteEngine2::WriteSection

IWriteEngine2EventArgs