IDtmEvents::OnProgress() method information

M&M FDT 1.2.1 Online Specification
IDtmEvents::OnProgress() method information

Interfaces and Methods - Schemas - FDT Specification - Quicklinks - Abbreviations

4.9.1.1 IDtmEvents::OnProgress()

This method can be called in the states:

HRESULT OnProgress (
[in] BSTR systemTag,
[in] BSTR title,
[in] short percent,
[in] VARIANT_BOOL show
);

Description:

A DTM sends a notification about the progress on handling of a function call.

Parameters:

systemTag	Identifier of the device instance
title	Description of the running process
percent	State of progress 0..100%
show	Set to TRUE, if the progress should be displayed, otherwise the progress would not be shown and an open progress bar must be closed within the Frame Application

Return Value:

Behavior:

This method should be used by DTMs during functions, which may take a longer time, to inform the Frame Application and at least the user about ongoing activities. If a DTM cannot determine the real progress, it can be useful to change e.g. the title. It’s up to the Frame Application how to handle the information.

Comments:

-/-

Related dtmINSPECTOR hints:

Thomas Weller
created on 2006-06-23, last updated on 2006-06-23

According to dtmINSPECTOR, the DTM has to call OnProgress() with the 'show' parameter set to FALSE as the last progress event of a sequence.

© by M&M Software GmbH, parts of this website taken from FDT Interface Specification Version 1.2.1, © by FDT Group, AISBL.
This website is published for support of M&M products as granted in license conditions, chapter 2.1.
Last updated 2015-02-05 15:17
Email: FDT Technical Support Line.