.. highlightlang:: us

.. _oledoverb:

OLEDoVerb
=========

.. index:: OLEDoVerb

.. us.tag  OLEDoVerb ENGLISH New330

:ref:`OLEDoVerb` requests an embedded object to perform an action.

.. function::  bool = OLEDoVerb(hOle, iVerb)

.. us.return

**Return Value**

If the function succeeds, the return value *bool* is TRUE (1); otherwise
it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hOle

   *hOle* is the handle of the OLE object

.. uparam:: iVerb

   *iVerb* is one of the possible actions:

.. list-table::
   :header-rows: 1

   * - Value
     - Meaning
   * - 0
     - PRIMARY: Default Open. Usually in-place activation if supported.
   * - -1
     - SHOW: Default Show.
   * - -2
     - OPEN: Opens the object for editing in a separate window.
   * - -3
     - HIDE: Removes its user interface.
   * - -4
     - UIActivate: Activates an object in place, along with its full set of user-interface tools.
   * - -5
     - INPLACEActivate: Activates an object in place without displaying tools.
   * - -6
     - DISCARDUNDOSTATE: Used to tell objects to discard any undo state.

.. seealso::
   :ref:`overview-programming`,
   :ref:`GetObject`,
   :ref:`CreateObjectEmbedded`

:sub:`id-1939469`