OmaT_Ot_Progress_Proc

Abstract

Callback: Used to manage progress bars when OT files are being read.

Syntax

<progress_proc_name> (count_or_option)
Argument Type Description
count_or_option int Status of file read (see Details)

Return Type

int

PRGC_TRUE if the file read should be aborted; PRGC_FALSE otherwise.

oma_ot.h

Details

Progress procedures use the ETS "Progress Bar Sub-Package" on page 244 to manage the progress bars that are displayed when OT files are read (by either Oma_Ot_Reader_Table_Get() or Oma_Ot_Reader_Iterator_Table_Get()).

If a progress proc is registered using Oma_Ot_Progress_Proc_Set(), the proc will be called several times as the OT file read proceeds. The count_or_option argument indicates the status of the read, as follows:

  • Initially, count_or_option is set to the number of tables that will be read. The progress proc should use this number to set up the progress bar.
  • Subsequently, as each table is read, count_or_option is set to OMAC_OT_PROGRESS_ADVANCE. This indicates that the progress proc should advance the progress bar by one file. If the user clicked the Cancel button in the progress bar, the proc should return PRGC_TRUE to abort the read.
  • Finally, when the read is complete, count_or_option is set to OMAC_OT_PROGRESS_FINISH. This indicates that the progress proc should close the progress bar.

This callback function is registered by Oma_Ot_Progress_Proc_Set().

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com