company logo

BaseContext :: displayProgress - Display progress status

The progress status is displayed usually as percentage of steps done, as number of steps related to the number of steps to do (or elements to process) or as elapsed and estimated time. Often, progress bars are used for visualizing the progress state.

In order to support different types of progress display, the progress message passes the number of processed elements or steps in iPosition64. The maximum number of steps or elements is passed in iMaximum64. The maximum number of steps might be estimated and updated with each progress message.

In order to provide application specific progress display, the function may be overloaded in the application context.

Implementation details

BaseContext  :: displayProgress ( odaba::String &sMessageText, int64 iPosition64, int64 iMaximum64 )
  • sMessageText - Message Text

    The message text is the text to be displayed in the message or decision. It may contain up to 500 characters.

  • iPosition64 - Position in an area or file

    The big position value usually refers to a relative position in an area or file.

  • iMaximum64 - Maximum value

    The maximum value contains the maximum number allowed (e.g. as position in a file or area).