Share via

OLEGETMONIKER (Compact 2013)

  • Article

3/26/2014

This enumeration contains values that indicate the requested behavior of the IOleObject::GetMoniker and IOleClientSite::GetMoniker methods.

Syntax

typedef enum tagOLEGETMONIKER { 
  OLEGETMONIKER_ONLYIFTHERE = 1,
  OLEGETMONIKER_FORCEASSIGN = 2,
  OLEGETMONIKER_UNASSIGN = 3,
  OLEGETMONIKER_TEMPFORUSER  = 4
} OLEGETMONIKER;

Elements

  • OLEGETMONIKER_ONLYIFTHERE
    If a moniker for the object or container does not exist, GetMoniker should return E_FAIL and not assign a moniker.
  • OLEGETMONIKER_FORCEASSIGN
    If a moniker for the object or container does not exist, GetMoniker should create one.
  • OLEGETMONIKER_UNASSIGN
    IOleClientSite::GetMoniker can release the object's moniker, although it is not required to do so. This constant is not valid in IOleObject::GetMoniker.

  • OLEGETMONIKER_TEMPFORUSER
    If a moniker for the object does not exist, IOleObject::GetMoniker can create a temporary moniker that can be used for display purposes (IMoniker::GetDisplayName) but not for binding.

    This enables the object server to return a descriptive name for the object without incurring the overhead of creating and maintaining a moniker until a link is actually created.

Remarks

If the OLEGETMONIKER_FORCEASSIGN flag causes a container to create a moniker for the object, the container should notify the object by calling the IOleObject::SetMoniker method.

Requirements

Header

Oleidl.h

See Also

Reference

COM Structures and Enumerations
IMoniker
IOleClientSite::GetMoniker
IOleObject::GetMoniker
IOleObject::SetMoniker