IOleInPlaceFrame::SetMenu method (oleidl.h)

Article
02/22/2024

Adds a composite menu to the window frame containing the object being activated in place.

Syntax

HRESULT SetMenu(
  [in] HMENU    hmenuShared,
  [in] HOLEMENU holemenu,
  [in] HWND     hwndActiveObject
);

Parameters

[in] hmenuShared

A handle to the composite menu constructed by calls to IOleInPlaceFrame::InsertMenus and the InsertMenu function.

[in] holemenu

A handle to the menu descriptor returned by the OleCreateMenuDescriptor function.

[in] hwndActiveObject

A handle to a window owned by the object and to which menu messages, commands, and accelerators are to be sent.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return code	Description
E_INVALIDARG	The specified handle is invalid.
E_UNEXPECTED	An unexpected error has occurred.

Remarks

Notes to Callers

The object calls IOleInPlaceFrame::SetMenu to ask the container to install the composite menu structure set up by calls to IOleInPlaceFrame::InsertMenus.

Notes to Implementers

An SDI container's implementation of this method should call the SetMenu function. An MDI container should send a WM_MDISETMENU message, using hmenuShared as the menu to install. The container should call OleSetMenuDescriptor to install the OLE dispatching code.

When deactivating, the container must call IOleInPlaceFrame::SetMenu, specifying NULL to remove the shared menu. This is done to help minimize window repaints. The container should also call OleSetMenuDescriptor, specifying NULL to unhook the dispatching code. Finally, the object application calls OleDestroyMenuDescriptor to free the data structure.

Note While executing IOleInPlaceFrame::SetMenu, do not make calls to the PeekMessage or GetMessage functions, or a dialog box. Doing so may cause the system to deadlock. There are further restrictions on which OLE interface methods and functions can be called from within IOleInPlaceFrame::SetMenu.

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	oleidl.h