IOleInPlaceFrame::SetMenu
Installs the
composite menu in the window frame containing the object being activated in
place.
HRESULT SetMenu(
|
HMENU hmenuShared, |
//Handle to composite menu |
|
HOLEMENU holemenu, |
//Handle to menu descriptor |
|
HWND hwndActiveObject |
//Handle to object s window |
|
); |
|
Parameters
hmenuShared
[in] Handle
to the composite menu constructed by calls to IOleInPlaceFrame::InsertMenus and
the Windows InsertMenu function.
holemenu
[in] Handle
to the menu descriptor returned by the OleCreateMenuDescriptor function.
hwndActiveObject
[in] Handle
to a window owned by the object and to which menu messages, commands, and
accelerators are to be sent.
Return Values
This method
supports the standard return values E_INVALIDARG and E_UNEXPECTED, as well as
the following:
S_OK
The method
completed successfully.
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 Windows 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 Windows 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 SetMenu.
See Also
PeekMessage, GetMessage in Win32