OleUIPromptUser
Displays a
dialog box with the specified template and returns the response (button
identifier) from the user. This function is used to display OLE warning
messages, for example, Class Not Registered.
int OleUIPromtUser(
|
int nTemplate, |
//Resource number of dialog box |
|
HWND hwndParent |
//Handle to the parent window of the dialog box |
|
); |
|
Parameters
nTemplate
[in] Resource
number of the dialog box to display. See Remarks.
hwndParent
[in] Handle
to the parent window of the dialog box. Specifies zero or more optional
arguments. These parameters are passed to wsprintf to format the message
string.
Return Values
Returns the
button identifier selected by the user (template dependent).
Standard
Success/Error Definitions
OLEUI_FALSE
Unknown
failure (unused).
OLEUI_SUCCESS
No error,
same as OLEUI_OK.
OLEUI_OK
The user pressed
the OK button.
OLEUI_CANCEL
The user pressed
the Cancel button.
Standard
Field Validation Errors
OLEUI_ERR_STANDARDMIN
Errors common
to all dialog boxes lie in the range OLEUI_ERR_STANDARDMIN to
OLEUI_ERR_STANDARDMAX. This value allows the application to test for standard
messages in order to display error messages to the user.
OLEUI_ERR_STRUCTURENULL
The pointer
to an OLEUIXXX structure passed into the function was NULL.
OLEUI_ERR_STRUCTUREINVALID
Insufficient
permissions for read or write access to an OLEUIXXX structure.
OLEUI_ERR_CBSTRUCTINCORRECT
The cbstruct
value is incorrect.
OLEUI_ERR_HWNDOWNERINVALID
The hWndOwner
value is invalid.
OLEUI_ERR_LPSZCAPTIONINVALID
The lpszCaption
value is invalid.
OLEUI_ERR_LPFNHOOKINVALID
The lpfnHook
value is invalid.
OLEUI_ERR_HINSTANCEINVALID
The hInstance
value is invalid.
OLEUI_ERR_LPSZTEMPLATEINVALID
The lpszTemplate
value is invalid.
OLEUI_ERR_HRESOURCEINVALID
The hResource
value is invalid.
Initialization
Errors
OLEUI_ERR_FINDTEMPLATEFAILURE
Unable to find
the dialog box template.
OLEUI_ERR_LOADTEMPLATEFAILURE
Unable to
load the dialog box template.
OLEUI_ERR_DIALOGFAILURE
Dialog box
initialization failed.
OLEUI_ERR_LOCALMEMALLOC
A call to LocalAlloc
or the standard IMalloc allocator failed.
OLEUI_ERR_GLOBALMEMALLOC
A call to GlobalAlloc
or the standard IMalloc allocator failed.
OLEUI_ERR_LOADSTRING
Unable to LoadString
localized resources from the library.
OLEUI_ERR_OLEMEMALLOC
A call to the
standard IMalloc allocator failed.
Function
Specific Errors
OLEUI_ERR_STANDARDMAX
Errors common
to all dialog boxes lie in the range OLEUI_ERR_STANDARDMIN to
OLEUI_ERR_STANDARDMAX. This value allows the application to test for standard
messages in order to display error messages to the user.
Remarks
The following
dialog box templates are defined in Windows Interface Guidelines--A Guide
for Designing Software. The nTemplate
parameter must be a currently defined resource, however, additional templates
can be added to prompt.dlg.
IDD_LINKSOURCEUNAVAILABLE
IDD_CANNOTUPDATELINK
IDD_SERVERNOTREG
IDD_CANNOTRESPONDVERB
IDD_SERVERNOTFOUND
IDD_UPDATELINKS
See Also