This method requests an object to perform an action in response to an end-user's action. The possible actions are enumerated for the object in IOleObject::EnumVerbs.

HRESULT DoVerb(
LONG
iVerb
,
LPMSG
lpmsg
,
IOleClientSite *
pActiveSite,

LONG
lindex
,
HWND
hwndParent
,
LPCRECT
lprcPosRect
);

Parameters

iVerb

[in] Number assigned to the verb in the OLEVERBstructure returned by IOleObject::EnumVerbs.

lpmsg

[in] Long pointer to the MSGstructure describing the event that invoked the verb. The caller should pass the MSG structure unmodified, without attempting to interpret or alter the values of any of the members of lpmsg.

pActiveSite

[in] Pointer to the IOleClientSiteinterface on the object's active client site, where the event occurred that invoked the verb.

lindex

[in] Reserved for future use; set to zero.

hwndParent

[in] Handle to the document window that contains the object. This and lprcPosRecttogether make it possible to open a temporary window for an object, where hwndParentis the parent window in which the object's window is to be displayed, and lprcPosRectdefines the area available for displaying the object window within that parent. A temporary window is useful, for example, to a multimedia object that opens itself for playback but not for editing.

lprcPosRect

[in] Long pointer to the RECTstructure that contains the coordinates, in pixels, that define an object's bounding rectangle in hwndParent. This and hwndParenttogether enable opening multimedia objects for playback but not for editing.

Return Values

One of the values described in the following table is returned.

Value	Description
S_OK	Object successfully invoked specified verb.
OLE_E_NOT_INPLACEACTIVE	The iVerbparameter is set to OLEIVERB_UIACTIVATE or OLEIVERB_INPLACEACTIVATE and object is not already visible.
OLE_E_CANT_BINDTOSOURCE	The object handler or link object cannot connect to the link source.
DV_E_LINDEX	Invalid lindex.
OLEOBJ_S_CANNOT_DOVERB_NOW	The verb is valid, but in the object's current state it cannot carry out the corresponding action.
OLEOBJ_S_INVALIDHWND	DoVerbwas successful but hwndParentis invalid.
OLEOBJ_E_NOVERBS	The object does not support any verbs.
OLEOBJ_S_INVALIDVERB	Object does not recognize a positive verb number. Verb is treated as OLEIVERB_PRIMARY.
MK_E_CONNECT	Link source is across a network that is not connected to a drive on this machine.
OLE_E_CLASSDIFF	Class for source of link has undergone a conversion.
E_NOTIMPL	Object does not support in-place activation or does not recognize a negative verb number.

Remarks

A "verb" is an action that an OLE object takes in response to a message from its container. An object's container, or a client linked to the object, normally calls IOleObject::DoVerbin response to some end-user action, such as double-clicking on the object. The various actions that are available for a given object are enumerated in an OLEVERBstructure, which the container obtains by calling IOleObject::EnumVerbs. IOleObject::DoVerbmatches the value of iVerbagainst the iVerbmember of the structure to determine which verb to invoke.

Through IOleObject::EnumVerbs, an object, rather than its container, determines which verbs (actions) it supports. OLE 2 defines seven verbs that are available, but not necessarily useful, to all objects. In addition, each object can define additional verbs that are unique to it. The following list describes the verbs defined by OLE:

OLEIVERB_PRIMARY (0L)

Specifies the action that occurs when an end user double-clicks the object in its container. The object, not the container, determines this action. If the object supports in-place activation, the primary verb usually activates the object in place.

OLEIVERB_SHOW (–1)

Instructs an object to show itself for editing or viewing. Called to display newly inserted objects for initial editing and to show link sources. Usually an alias for some other object-defined verb.

OLEIVERB_OPEN (–2)

Instructs an object, including one that otherwise supports in-place activation, to open itself for editing in a window separate from that of its container. If the object does not support in-place activation, this verb has the same semantics as OLEIVERB_SHOW.

OLEIVERB_HIDE (–3)

Causes an object to remove its user interface from the view. Applies only to objects that are activated in-place.

OLEIVERB_UIACTIVATE (–4)

Activates an object in place, along with its full set of user-interface tools, including menus, toolbars, and its name in the title bar of the container window. If the object does not support in-place activation, it should return E_NOTIMPL.

OLEIVERB_INPLACEACTIVATE (–5)

Activates an object in place without displaying tools, such as menus and toolbars, that end users need to change the behavior or appearance of the object. Single-clicking such an object causes it to negotiate the display of its user-interface tools with its container. If the container refuses, the object remains active but without its tools displayed.

OLEIVERB_DISCARDUNDOSTATE (–6)

Used to tell objects to discard any undo state that they may be maintaining without deactivating the object.

Note to Callers

Containers call IOleObject::DoVerbas part of initializing a newly created object. Before making the call, containers should first call IOleObject::SetClientSiteto inform the object of its display location and IOleObject::SetHostNamesto alert the object that it is an embedded object and to trigger appropriate changes to the user interface of the object application in preparation for opening an editing window.

Like the OleActivatefunction in OLE 1, IOleObject::DoVerbautomatically runs the OLE server application. If an error occurs during verb execution, the object application is shut down.

If an end user invokes a verb by some means other than selecting a command from a menu (say, by double-clicking or, more rarely, single-clicking an object), the object's container should pass a pointer ( lpmsg) to a Windows MSGstructure that contains the appropriate message. For example, if the end user invokes a verb by double-clicking the object, the container should pass a MSGstructure that contains WM_LBUTTONDBLCLK, WM_MBUTTONDBLCLK, or WM_RBUTTONDBLCLK. If the container passes no message, lpmsgshould be set to NULL. The object should ignore the hwndmember of the passed MSGstructure, but can use all the other MSGmembers.

If the object's embedding container calls IOleObject::DoVerb, the client-site pointer ( pClientSite) passed to DoVerbis the same as that of the embedding site. If the embedded object is a link source, the pointer passed to DoVerbis that of the linking client's client site.

When IOleObject::DoVerbis invoked on an OLE link, it may return OLE_E_CLASSDIFF or MK_CONNECTMANUALLY. The link object returns the former error when the link source has been subjected to some sort of conversion while the link was passive. The link object returns the latter error when the link source is located on a network drive that is not currently connected to the caller's computer.

Container applications that do not support general in-place activation can still use the hwndParentand lprcPosRectparameters to support in-place playback of multimedia files. Containers must pass valid hwndParentand lprcPosRectparameters to IOleObject::DoVerb.

Some code samples pass a lindexvalue of –1 instead of zero. The value –1 works but should be avoided in favor of zero. The lindexparameter is a reserved parameter, and for reasons of consistency Microsoft recommends assigning a zero value to all reserved parameters.

Notes to Implementers

In addition to the above verbs, an object can define in its OLEVERBstructure additional verbs that are specific to itself. Positive numbers designate these object-specific verbs. An object should treat any unknown positiveverb number as if it were the primary verb and return OLE_S_INVALIDVERB to the calling function. The object should ignore verbs with negative numbers that it does not recognize and return E_NOTIMPL.

If the verb being executed places the object in the running state, you should register the object in the Running Object Table (ROT) even if its server application doesn't support linking. Registration is important because the object at some point may serve as the source of a link in a container that supports links to embeddings. Registering the object with the ROT enables the link client to get a pointer to the object directly, instead of having to go through the object's container. To perform the registration, call IOleClientSite::GetMonikerto get the full moniker of the object, call the GetRunningObjectTablefunction to get a pointer to the ROT, and then call IRunningObjectTable::Register.

Note   When the object leaves the running state, remember to revoke the object's registration with the ROT by calling IOleObject::Close. If the object's container document is renamed while the object is running, you should revoke the object's registration and re-register it with the ROT, using its new name. The container should inform the object of its new moniker either by calling IOleObject::SetMonikeror by responding to the object's calling IOleClientSite::GetMoniker.

When showing a window as a result of DoVerb, it is very important for the object to explicitly call SetForegroundWindowon its editing window. This ensures that the object's window will be visible to the user even if another process originally obscured it. For more information about SetForegroundWindowand SetActiveWindow, see the Platform SDK.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	2.0 and later	Oleidl.h

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

---

Last updated on Friday, May 26, 2006

© 2004 Microsoft Corporation. All rights reserved.