Edit

Share via

OLEGETMONIKER enumeration (oleidl.h)

  • Article

Controls aspects of the 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;

Constants

 
OLEGETMONIKER_ONLYIFTHERE
Value: 1
If a moniker for the object or container does not exist, IOleClientSite::GetMoniker should return E_FAIL and not assign a moniker.
OLEGETMONIKER_FORCEASSIGN
Value: 2
If a moniker for the object or container does not exist, IOleClientSite::GetMoniker should create one.
OLEGETMONIKER_UNASSIGN
Value: 3
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
Value: 4
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::GetMoniker method.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header oleidl.h

See also

IMoniker

IOleClientSite::GetMoniker

IOleObject::GetMoniker