COleBusyDialog Class
Used for the OLE Server Not Responding or Server Busy dialog boxes.
Syntax
class COleBusyDialog : public COleDialog
Members
Public Constructors
Name | Description |
---|---|
COleBusyDialog::COleBusyDialog | Constructs a COleBusyDialog object. |
Public Methods
Name | Description |
---|---|
COleBusyDialog::DoModal | Displays the OLE Server Busy dialog box. |
COleBusyDialog::GetSelectionType | Determines the choice made in the dialog box. |
Public Data Members
Name | Description |
---|---|
COleBusyDialog::m_bz | Structure of type OLEUIBUSY that controls the behavior of the dialog box. |
Remarks
Create an object of class COleBusyDialog
when you want to call these dialog boxes. After a COleBusyDialog
object has been constructed, you can use the m_bz structure to initialize the values or states of controls in the dialog box. The m_bz
structure is of type OLEUIBUSY. For more information about using this dialog class, see the DoModal member function.
Note
Application Wizard-generated container code uses this class.
For more information, see the OLEUIBUSY structure in the Windows SDK.
For more information on OLE-specific dialog boxes, see the article Dialog Boxes in OLE.
Inheritance Hierarchy
COleBusyDialog
Requirements
Header: afxodlgs.h
COleBusyDialog::COleBusyDialog
This function only constructs a COleBusyDialog
object.
explicit COleBusyDialog(
HTASK htaskBusy,
BOOL bNotResponding = FALSE,
DWORD dwFlags = 0,
CWnd* pParentWnd = NULL);
Parameters
htaskBusy
Handle to the server task that is busy.
bNotResponding
If TRUE, call the Not Responding dialog box instead of the Server Busy dialog box. The wording in the Not Responding dialog box is slightly different than the wording in the Server Busy dialog box, and the Cancel button is disabled.
dwFlags
Creation flag. Can contain zero or more of the following values combined with the bitwise-OR operator:
BZ_DISABLECANCELBUTTON Disable the Cancel button when calling the dialog box.
BZ_DISABLESWITCHTOBUTTON Disable the Switch To button when calling the dialog box.
BZ_DISABLERETRYBUTTON Disable the Retry button when calling the dialog box.
pParentWnd
Points to the parent or owner window object (of type CWnd
) to which the dialog object belongs. If it is NULL, the parent window of the dialog object is set to the main application window.
Remarks
To display the dialog box, call DoModal.
For more information, see the OLEUIBUSY structure in the Windows SDK.
COleBusyDialog::DoModal
Call this function to display the OLE Server Busy or Server Not Responding dialog box.
virtual INT_PTR DoModal();
Return Value
Completion status for the dialog box. One of the following values:
IDOK if the dialog box was successfully displayed.
IDCANCEL if the user canceled the dialog box.
IDABORT if an error occurred. If IDABORT is returned, call the
COleDialog::GetLastError
member function to get more information about the type of error that occurred. For a listing of possible errors, see the OleUIBusy function in the Windows SDK.
Remarks
If you want to initialize the various dialog box controls by setting members of the m_bz structure, you should do this before calling DoModal
, but after the dialog object is constructed.
If DoModal
returns IDOK, you can call other member functions to retrieve the settings or information that was input by the user into the dialog box.
COleBusyDialog::GetSelectionType
Call this function to get the selection type chosen by the user in the Server Busy dialog box.
UINT GetSelectionType() const;
Return Value
Type of selection made.
Remarks
The return type values are specified by the Selection
enumeration type declared in the COleBusyDialog
class.
enum Selection {
switchTo,
retry,
callUnblocked
};
Brief descriptions of these values follow:
COleBusyDialog::switchTo
Switch To button was pressed.COleBusyDialog::retry
Retry button was pressed.COleBusyDialog::callUnblocked
Call to activate the server is now unblocked.
COleBusyDialog::m_bz
Structure of type OLEUIBUSY used to control the behavior of the Server Busy dialog box.
OLEUIBUSY m_bz;
Remarks
Members of this structure can be modified directly or through member functions.
For more information, see the OLEUIBUSY structure in the Windows SDK.