OleUIChangeIcon function
Invokes the standard Change Icon dialog box, which allows the user to select an icon from an icon file, executable, or DLL.
Syntax
UINT OleUIChangeIcon( _In_ LPOLEUICHANGEICON lpCI );
Parameters
- lpCI [in]
-
Pointer to the In/Out OLEUICHANGEICON structure for this dialog box.
Return value
Standard Success/Error Definitions
| Return code | Description |
|---|---|
|
Unknown failure (unused). |
|
The user pressed the OK button. |
|
No error, same as OLEUI_OK. |
|
The user pressed the Cancel button. |
Standard Field Validation Errors
| Return code | Description |
|---|---|
|
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. |
|
The pointer to an OLEUIXXX structure passed into the function was NULL. |
|
Insufficient permissions for read or write access to an OLEUIXXX structure. |
|
The cbstruct value is incorrect. |
|
The hWndOwner value is invalid. |
|
The lpszCaption value is invalid. |
|
The lpfnHook value is invalid. |
|
The hInstance value is invalid. |
|
The lpszTemplate value is invalid. |
|
The hResource value is invalid. |
Initialization Errors
| Return code | Description |
|---|---|
|
Unable to find the dialog box template. |
|
Unable to load the dialog box template. |
|
Dialog box initialization failed. |
|
A call to LocalAlloc or the standard IMalloc allocator failed. |
|
A call to GlobalAlloc or the standard IMalloc allocator failed. |
|
Unable to call LoadString for localized resources from the library. |
|
A call to the standard IMalloc allocator failed. |
Function Specific Errors
| Return code | Description |
|---|---|
|
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. |
|
The clsid member was not the current CLSID. |
|
The hMetaPict member was not the current metafile. |
|
The szIconExe value was invalid. |
Remarks
OleUIChangeIcon uses information contained in the OLEUICHANGEICON structure.
Requirements
|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
OleUIChangeIconW (Unicode) and OleUIChangeIconA (ANSI) |
See also