OLEUIBUSY - OLE Programmer's Reference (ole.hlp)

OLEUIBUSY

The OLEUIBUSY structure contains information that the OLE 2.01 User Interface Library uses to initialize the Busy dialog box, and space for the library to return information when the dialog is dismissed.

typedef struct tagOLEUIBUSY

{

// These IN fields are standard across all OLEUI dialog functions.
DWORD cbStruct;

DWORD dwFlags;

HWND hWndOwner;

LPCSTR lpszCaption;

LPFNOLEUIHOOK lpfnHook;

LPARAM lCustData;

HINSTANCE hInstance;

LPCSTR lpszTemplate;

HRSRC hResource;

// Specifics for OLEUIBUSY.

HTASK hTask;

HWND FAR * lphWndDialog;

} OLEUICHANGEICON, *POLEUICHANGEICON, FAR *LPOLEUICHANGEICON;

Members
cbStruct

The size of the structure in bytes. This field must be filled on input.

dwFlags

On input, dwFlags specifies the initialization and creation flags. On exit, it specifies the user's choices. It may be a combination of the following flags:

BZ_DISABLECANCELBUTTON

Input only: This flag disables the Cancel button.

BZ_DISABLESWITCHTOBUTTON

Input only: This flag disables the Switch To... button.

BZ_DISABLERETRYBUTTON

Input only: This flag disables the Retry button.

BZ_NOTRESPONDINGDIALOG

Input only: This flag generates a Not Responding dialog instead of a Busy dialog. The text is slightly different, and the Cancel button is disabled.

hWndOwner

Identifies the window that owns the dialog box. It should not be NULL.

lpszCaption

Points to a string to be used as the title of the dialog box. If NULL, then the library uses Busy.

lpfnHook

Points to a hook function that processes messages intended for the dialog box. The hook function must return zero to pass a message that it didn't process back to the dialog box procedure in the library. The hook function must return a non zero value to prevent the library's dialog box procedure from processing a message it has already processed.

lCustData

Specifies application-defined data that the library passes to the hook function pointed to by the lpfnHook member. The library passes a pointer to the OLEUIBUSY structure in the lParam parameter of the WM_INITDIALOG message; this pointer can be used to retrieve the lCustData member.

hInstance

Identifies an instance that contains a dialog box template specified by the lpTemplateName member.

lpszTemplate

Points to a null-terminated string that specifies the name of the resource file for the dialog box template that is to be substituted for the library's Busy dialog box template.

hResource

A customized template handle.

hTask Input only:

A handle to the task that is blocking.

lphWndDialog

The dialog box's HWND is placed here.