Share via


OleSetMenuDescriptor (Compact 2013)

3/26/2014

This function installs or removes OLE dispatching code from the container's frame window.

Syntax

WINOLEAPI OleSetMenuDescriptor( 
  HOLEMENU holemenu, 
  HWND hwndFrame, 
  HWND hwndActiveObject, 
  LPOLEINPLACEFRAME lpFrame, 
  LPOLEINPLACEACTIVEOBJECT lpActiveObj 
);

Parameters

  • holemenu
    [in] Handle to the composite menu descriptor returned by the OleCreateMenuDescriptor function.

    If NULL, the dispatching code is unhooked.

  • hwndFrame
    [in] Handle to the container's frame window where the in-place composite menu is to be installed.
  • hwndActiveObject
    [in] Handle to the object's in-place activation window. OLE dispatches menu messages and commands to this window.
  • lpFrame
    [in] Long pointer to the IOleInPlaceFrame interface on the container's frame window.
  • lpActiveObj
    [in] Long pointer to the IOleInPlaceActiveObject interface on the active in-place object.

Return Value

The following HRESULT values can be returned.

Value

Description

S_OK

The menu was correctly installed.

E_FAIL

The function has failed.

E_INVALIDARG

The function has failed.

E_UNEXPECTED

The function has failed.

Remarks

The hwndActiveObject and the lpActiveObj parameters are not supported. Set to NULL.

If the lpFrame and lpActiveObj parameters are non-NULL, OLE installs the context-sensitive help F1 message filter for the application. Otherwise, the application must supply its own message filter.

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

Header

ole2.h

Library

ole32.lib

See Also

Tasks

Determine Supported COM APIs

Reference

OLE Functions
Automation Functions