#include "mdl.h"
#include "dlogbox.r.h"
#include "dlogitem.h"
#include "dlogids.r.h"

Functions
int	mdlDialog_busyBarStartProcessing (int(workFuncP)(void ), void funcParmsP, void(completionFuncP)(int, void ), void(cancelFuncP)(void *), WCharCP cancelMessage, int rectangle, WCharCP msgStr, WCharCP windowTitle)
	Initializes the processing environment, opens the busy bar window, and starts the processing for the calling application by calling the application's MDL work function as specified by the required workFuncP parameter after a small time delay. More...

void	mdlDialog_busyBarStopProcessing ()
	Closes down the busy bar processing environment and closes the busy bar window. More...

void	mdlDialog_busyBarUpdateMessage (WCharCP msgStr)
	Displays the message pointed to by the msgStr parameter in the busy bar window as an indication of the current processing state of the application. More...

int	mdlDialog_busyBarUpdateControlParms (int(workFuncP)(void ), void funcParmsP, void(completionFuncP)(int, void ), void(cancelFuncP)(void *), WCharCP cancelMessage, WCharCP msgStr)
	Updates control information relating to the busy bar window operation currently active. More...

int	mdlDialog_trackBarStartProcessing (int(workFuncP)(void ), void funcParmsP, void(completionFuncP)(int, void ), void(cancelFuncP)(void ), WCharCP cancelMessage, int stackedCompletionBars, TrackBarInfo trackBarInfoP, WCharCP windowTitle)
	Initializes the processing environment, opens the track bar window, and starts the processing for the calling application by calling the application's MDL work function as specified by the required workFuncP parameter after a small time delay. More...

void	mdlDialog_trackBarStopProcessing ()
	Closes down the track bar processing environment and closes the track bar window. More...

void	mdlDialog_trackBarUpdateDisplayInfo (TrackBarInfo *trackBarInfoP)
	Updates the track bar window with the information supplied in the information pointed to by trackBarInfoP as an indication of the current processing state of the application. More...

int	mdlDialog_trackBarUpdateControlParms (int(workFuncP)(void ), void funcParmsP, void(completionFuncP)(int, void ), void(cancelFuncP)(void ), WCharCP cancelMessage, TrackBarInfo trackBarInfoP)
	Updates control information relating to the track bar window operation currently active. More...

Function Documentation

int mdlDialog_busyBarStartProcessing	(	int()(void )	workFuncP,
		void *	funcParmsP,
		void()(int, void )	completionFuncP,
		void()(void )	cancelFuncP,
		WCharCP	cancelMessage,
		int	rectangle,
		WCharCP	msgStr,
		WCharCP	windowTitle
	)

Initializes the processing environment, opens the busy bar window, and starts the processing for the calling application by calling the application's MDL work function as specified by the required workFuncP parameter after a small time delay.

The MDL function pointed to by workFuncP should be written to perform an incremental amount of work with each call to the function. The rest of the parameters are optional.

Parameters

[in]	workFuncP	work function pointer
[in]	funcParmsP	The funcParmsP parameter is a pointer to the parameter which is passed to all functions which can be called by the busy bar window.
[in]	completionFuncP	is an MDL function pointer which points to the application completion function which will get control when all busy bar processing has been completed. A value of NULL indicates no completion function.
[in]	cancelFuncP	is an MDL function pointer which points to the application cancel function which will get control when the user activates the CANCEL button in the busy bar window. A value of NULL indicates no cancel function.
[in]	cancelMessage	is a pointer to a message to be displayed to the user to confirm the user's desire to cancel the current operation. A value of NULL indicates that the standard confirmation message of "Cancel current operation?" should be used.
[in]	rectangle	is a flag indicating whether the busy bar style used displays sliding rectangles or sliding parallelograms. A value of 0 indicates parallelograms should be used.
[in]	msgStr	is a pointer to the initial message string to be displayed in the busy bar window describing the current operational status of the work in progress. A value of NULL indicates no message is to be displayed.
[in]	windowTitle	is a pointer to a string which is to be used as the title of the busy bar window. A value of NULL indicates that the default title of "Busy" is to be used.

Remarks: This function was implemented in MicroStation 95.

Returns: SUCCESS, or ERROR if an error occurred or a busy/ track bar is currently active.

See also: mdlDialog_busyBarStopProcessing mdlDialog_busyBarUpdateMessage mdlDialog_busyBarUpdateControlParms mdlDialog_completionBarOpen mdlDialog_trackBarStartProcessing userBar_workFunction userBar_cancelFunction userBar_completionFunction

void mdlDialog_busyBarStopProcessing ( )

Closes down the busy bar processing environment and closes the busy bar window.

The application completion function is not called as a result of calling this function.

Remarks: This function was implemented in MicroStation 95.

See also: mdlDialog_busyBarStartProcessing mdlDialog_busyBarUpdateMessage mdlDialog_busyBarUpdateControlParms mdlDialog_completionBarClose mdlDialog_trackBarStopProcessing

int mdlDialog_busyBarUpdateControlParms	(	int()(void )	workFuncP,
		void *	funcParmsP,
		void()(int, void )	completionFuncP,
		void()(void )	cancelFuncP,
		WCharCP	cancelMessage,
		WCharCP	msgStr
	)

Updates control information relating to the busy bar window operation currently active.

Any portion of the control information may be updated and NULL may be specified for any parameter which is to remain unchanged. This function is useful in applications which will perform a number of different operations while still maintaining the busy bar window.

Parameters

[in]	workFuncP	is an MDL function pointer which points to the application work function which will get control to allow the application to perform a piece of work at short timer intervals. The MDL function pointed to by workFuncP should be written to perform an incremental amount of work with each call to the function. A value of NULL indicates no change to this control information.
[in]	funcParmsP	The funcParmsP parameter is a pointer to the parameter which is passed to all functions which can be called by the busy bar window. A value of NULL indicates no change to this control information.
[in]	completionFuncP	is an MDL function pointer which points to the application completion function which will get control when all busy bar processing has been completed. A value of NULL indicates no change to this control information.
[in]	cancelFuncP	is an MDL function pointer which points to the application cancel function which will get control when the user activates the CANCEL button in the busy bar window. A value of NULL indicates no change to this control information.
[in]	cancelMessage	is a pointer to a message to be displayed to the user to confirm the user's desire to cancel the current operation. A value of NULL indicates no change to this control information.
[in]	msgStr	is a pointer to the message string to be displayed in the busy bar window describing the current operational status of the work in progress. A value of NULL indicates no change to this control information.

Remarks: This function was implemented in MicroStation 95.

Returns: SUCCESS, or ERROR if an error occurred or a busy bar is not currently active.

See also: mdlDialog_busyBarStartProcessing mdlDialog_busyBarStopProcessing mdlDialog_busyBarUpdateMessage mdlDialog_trackBarUpdateControlParms userBar_workFunction userBar_cancelFunction userBar_completionFunction

void mdlDialog_busyBarUpdateMessage ( WCharCP msgStr )

Displays the message pointed to by the msgStr parameter in the busy bar window as an indication of the current processing state of the application.

Parameters

[in] msgStr display message

Remarks: This function was implemented in MicroStation 95.

See also: mdlDialog_busyBarStopProcessing mdlDialog_busyBarUpdateMessage mdlDialog_busyBarUpdateControlParms mdlDialog_completionBarOpen mdlDialog_trackBarStartProcessing userBar_workFunction userBar_cancelFunction userBar_completionFunction

int mdlDialog_trackBarStartProcessing	(	int()(void )	workFuncP,
		void *	funcParmsP,
		void()(int, void )	completionFuncP,
		void()(void )	cancelFuncP,
		WCharCP	cancelMessage,
		int	stackedCompletionBars,
		TrackBarInfo *	trackBarInfoP,
		WCharCP	windowTitle
	)

Initializes the processing environment, opens the track bar window, and starts the processing for the calling application by calling the application's MDL work function as specified by the required workFuncP parameter after a small time delay.

The MDL function pointed to by workFuncP should be written to perform an incremental amount of work with each call to the function. The rest of the parameters are optional.

Parameters

[in]	workFuncP	work function pointer
[in]	funcParmsP	The funcParmsP parameter is a pointer to the parameter which is passed to all functions which can be called by the track bar window.
[in]	completionFuncP	is an MDL function pointer which points to the application completion function which will get control when all track bar processing has been completed. A value of NULL indicates no completion function.
[in]	cancelFuncP	is an MDL function pointer which points to the application cancel function which will get control when the user activates the CANCEL button in the track bar window. A value of NULL indicates no cancel function.
[in]	cancelMessage	is a pointer to a message to be displayed to the user to confirm the user's desire to cancel the current operation. A value of NULL indicates that the standard confirmation message of "Cancel current operation?" should be used.
[in]	stackedCompletionBars	is a flag indicating whether the track bar should display a single completion bar as is done in the completion bar window or two stacked completion bars so that two separate granularities of processing or events can be tracked. A value of 0 indicates a single completion bar should be used.
[in]	trackBarInfoP	is a pointer to the track bar control information indicating percent completion and messages to be displayed above each completion bar. The information in this structure is used to set the initial display values for the track bar window. The update field of this structure contains an indication as to which fields in this structure contain valid information.

Remarks: The structure of this information and associated definitions are:
#define UPDATE_Percent1 1

#define UPDATE_Percent2 2

#define UPDATE_Msg1 4

#define UPDATE_Msg2 8

#define UPDATE_All 15

struct TrackBarInfo

{

int update; // Which fields to update

long percentComplete1; // Percent complete - bar 1 (top)

long percentComplete2; // Percent complete - bar 2 (bottom)

WChar msgText1[256]; // Message text - bar 1 (top)

WChar msgText2[256]; // Message text - bar 2 (bottom)

};

Parameters

[in] windowTitle is a pointer to a string which is to be used as the title of the track bar window. A value of NULL indicates that the default title of "Working" is to be used.

Remarks: This function was implemented in MicroStation 95.

Returns: SUCCESS, or ERROR if an error occurred or a busy/track bar is currently active.

See also: mdlDialog_trackBarStopProcessing mdlDialog_trackBarUpdateMessage mdlDialog_trackBarUpdateControlParms mdlDialog_completionBarOpen mdlDialog_busyBarStartProcessing userBar_workFunction userBar_cancelFunction userBar_completionFunction

void mdlDialog_trackBarStopProcessing ( )

Closes down the track bar processing environment and closes the track bar window.

The application completion function is not called as a result of calling this function.

Remarks: This function was implemented in MicroStation 95.

See also: mdlDialog_trackBarStartProcessing mdlDialog_trackBarUpdateMessage mdlDialog_trackBarUpdateControlParms mdlDialog_completionBarClose mdlDialog_busyBarStopProcessing

int mdlDialog_trackBarUpdateControlParms	(	int()(void )	workFuncP,
		void *	funcParmsP,
		void()(int, void )	completionFuncP,
		void()(void )	cancelFuncP,
		WCharCP	cancelMessage,
		TrackBarInfo *	trackBarInfoP
	)

Updates control information relating to the track bar window operation currently active.

Any portion of the control information may be updated and NULL may be specified for any parameter which is to remain unchanged. This function is useful in applications which will perform a number of different operations while still maintaining the track bar window.

Parameters

[in]	workFuncP	is an MDL function pointer which points to the application work function which will gets control to allow the application to perform a piece of work at short timer intervals. The MDL function pointed to by workFuncP should be written to perform an incremental amount of work with each call to the function. A value of NULL indicates no change to this control information.
[in]	funcParmsP	The funcParmsP parameter is a pointer to the parameter which is passed to all functions which can be called by the track bar window. A value of NULL indicates no change to this control information.
[in]	completionFuncP	is an MDL function pointer which points to the application completion function which will get control when all track bar processing has been completed. A value of NULL indicates no change to this control information.
[in]	cancelFuncP	is an MDL function pointer which points to the application cancel function which will get control when the user activates the CANCEL button in the track bar window. A value of NULL indicates no change to this control information.
[in]	cancelMessage	is a pointer to a message to be displayed to the user to confirm the user's desire to cancel the current operation. A value of NULL indicates no change to this control information.
[in]	trackBarInfoP	is a pointer to the track bar control information indicating percent completion and messages to be displayed above each completion bar. The information in this structure is used to update the current display information in the track bar window. A value of NULL indicates no change to this control information.

Remarks: This function was implemented in MicroStation 95.

Returns: SUCCESS, or ERROR if an error occurred or a track bar is not currently active.

See also: mdlDialog_trackBarStartProcessing mdlDialog_trackBarStopProcessing mdlDialog_trackBarUpdateMessage mdlDialog_busyBarUpdateControlParms userBar_workFunction userBar_cancelFunction userBar_completionFunction

void mdlDialog_trackBarUpdateDisplayInfo ( TrackBarInfo * trackBarInfoP )

Updates the track bar window with the information supplied in the information pointed to by trackBarInfoP as an indication of the current processing state of the application.

The fields to be updated from information within this structure are defined using the update field of this structure.

Parameters

[in] trackBarInfoP Display information

Remarks: This function was implemented in MicroStation 95.

See also: mdlDialog_trackBarStartProcessing mdlDialog_trackBarStopProcessing mdlDialog_trackBarUpdateMessage mdlDialog_trackBarUpdateControlParms mdlDialog_completionBarOpen mdlDialog_busyBarUpdateMessage userBar_workFunction userBar_cancelFunction userBar_completionFunction

Functions

Function Documentation