OleUIObjectProperties function
Invokes the Object Properties dialog box, which displays General, View, and Link information about an object.
Syntax
UINT OleUIObjectProperties( _In_ LPOLEUIOBJECTPROPS lpOF );
Parameters
- lpOF [in]
-
Pointer to the OLEUIOBJECTPROPS structure.
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
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. |
|
lpGP or lpVP is NULL, or dwFlags and OPF_OBJECTISLINK and lpLP are NULL. |
|
Insufficient write-access permissions for the structures pointed to by lpGP, lpVP, or lpLP. |
|
The lpLP value is NULL. |
|
Insufficient write-access permissions for the structures pointed to by lpGP, lpVP, or lpLP. |
|
The sub-link property pointer, lpLP, is NULL. |
|
Insufficient write access for the sub-link property pointer, lpLP. |
|
Some sub-link properties of the lpPS member are incorrect. |
|
Some sub-link properties of the lpPS member are incorrect. |
|
A sub-link property of the lpPS member is incorrect. |
|
A sub-link property of the lpPS member is incorrect. |
|
A sub-link property of the lpPS member is incorrect. |
|
A string value (for example, lplpszLabel or lplpszType) is invalid. |
|
The clsid value is invalid. |
|
The ClsidExcluded value is invalid. |
|
The wFormat value is invalid. |
|
The hMetaPict value is invalid. |
|
The dvAspect value is invalid. |
|
The lpPS value is incorrect. |
|
The lpObjInfo value is NULL or the calling process doesn't have read access. |
|
The lpLinkInfo value is NULL or the calling process doesn't have read access. |
Remarks
OleUIObjectProperties is passed an OLEUIOBJECTPROPS structure, which supplies the information needed to fill in the General, View, and Link tabs of the Object Properties dialog box.
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 |
OleUIObjectPropertiesW (Unicode) and OleUIObjectPropertiesA (ANSI) |
See also