Functions

Functions

void mdlDialog_completionBarUpdate (MSDialogP dbP, WCharCP msgText, int percentComplete)
 Updates the completion bar window to display the message defined by the messageText parameter and the percent complete defined by the percentComplete parameter. More...
 
void mdlDialog_completionBarDisplayMessage (MSDialogP dbP, WCharCP msgText)
 Displays a text message defined by the messageText parameter in the message box of the completion bar window. More...
 
void mdlDialog_completionBarClose (MSDialogP dbP)
 Closes the completion bar window pointed to by the dbP parameter. More...
 
MSDialogP mdlDialog_completionBarOpen (WCharCP messageText)
 Opens the completion bar window, displays the text defined by the messageText parameter in the window, and returns a pointer to the window to the calling application. More...
 

Detailed Description

Function Documentation

void mdlDialog_completionBarClose ( MSDialogP  dbP)

Closes the completion bar window pointed to by the dbP parameter.

If the message box below the completion bar was opened by sending messages to the completion bar window using the mdlDialog_completionBarDisplayMessage function, then the window is not closed and the user must close the window by pressing the "Close" button.

Parameters
[in]dbPCompletion Bar DB Pointer
See also
mdlDialog_completionBarOpen mdlDialog_completionBarUpdate mdlDialog_completionBarDisplayMessage mdlDialog_busyBarStopProcessing mdlDialog_trackBarStopProcessing
Remarks
Required Library: mdlbltin.lib
void mdlDialog_completionBarDisplayMessage ( MSDialogP  dbP,
WCharCP  msgText 
)

Displays a text message defined by the messageText parameter in the message box of the completion bar window.

Parameters
[in]dbPcompletion of bar DB pointer
[in]msgTexttext to display in message window
See also
mdlDialog_completionBarOpen mdlDialog_completionBarClose mdlDialog_completionBarUpdate mdlDialog_busyBarUpdateMessage mdlDialog_trackBarUpdateDisplayInfo mdlDialog_busyBarUpdateControlParms mdlDialog_busyBarUpdateControlParms
Remarks
Required Library: mdlbltin.lib
MSDialogP mdlDialog_completionBarOpen ( WCharCP  messageText)

Opens the completion bar window, displays the text defined by the messageText parameter in the window, and returns a pointer to the window to the calling application.

If the window is already opened, the window is re-initialized and a pointer to the existing window is returned.

Parameters
[in]messageTextmessage text for Dialog Box
Remarks
The completion bar window displays a rectangle graphically depicting the percentage complete for the operation indicated by the text message passed in messageText. A numeric percent complete is displayed above the completion bar. A message box is displayed below the completion bar if status messages are sent to the completion bar window–if no messages are sent, no message box is displayed.
Returns
A pointer to the opened completion bar window or NULL if the open failed.
See also
mdlDialog_completionBarClose mdlDialog_completionBarUpdate mdlDialog_completionBarDisplayMessage mdlDialog_busyBarStartProcessing mdlDialog_trackBarStartProcessing
Remarks
Required Library: mdlbltin.lib
void mdlDialog_completionBarUpdate ( MSDialogP  dbP,
WCharCP  msgText,
int  percentComplete 
)

Updates the completion bar window to display the message defined by the messageText parameter and the percent complete defined by the percentComplete parameter.

The valid values for percentComplete are 0 through 100.

Parameters
[in]dbPcompletion of bar DB pointer
[in]msgTextmessage text
[in]percentCompletepercentage complete on bar
See also
mdlDialog_completionBarOpen mdlDialog_completionBarClose mdlDialog_completionBarDisplayMessage mdlDialog_busyBarUpdateMessage mdlDialog_trackBarUpdateDisplayInfo mdlDialog_busyBarUpdateControlParms mdlDialog_trackBarUpdateControlParms
Remarks
Required Library: mdlbltin.lib

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.