OleUIConvertA function (oledlg.h)
Invokes the standard Convert dialog box, allowing the user to change the type of a single specified object, or the type of all OLE objects of the specified object's class.
Syntax
UINT OleUIConvertA(
[in] LPOLEUICONVERTA unnamedParam1
);
Parameters
[in] unnamedParam1
Pointer to an OLEUICONVERT structure that contains information used to initialize the 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. |
|
A clsid value was invalid. |
|
The dvAspect value was invalid. This member specifies the aspect of the object. |
|
The wFormat value was invalid. This member specifies the data format of the object. |
|
A string value (for example, lpszUserType or lpszDefLabel) was invalid. |
Remarks
OleUIConvert populates the Convert dialog box's list box with object classes by traversing the registry and looking for entries in the Readable and ReadWritable keys. Every class that includes the original class' default file format in its Readable key is added to the Convert list, and every class that includes the original class' default file format in its ReadWritable key is added to the Activate As list. The Convert list is shown in the dialog box's list box when the Convert radio button is selected (the default selection), and the Activate As list is shown when Activate As is selected.
Note that you can change the type of all objects of a given class only when CF_CONVERTONLY is not specified.
The convert command, which invokes this function, should only be made available to the user if OleUICanConvertOrActivateAs returns S_OK.
Note
The oledlg.h header defines OLEUICONVERT as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | oledlg.h |
| Library | OleDlg.lib |
| DLL | OleDlg.dll |