OleRegEnumVerbs

Supplies an enumeration of the registered verbs for the specified class. Developers of custom DLL object applications use this function to emulate the behavior of the default object handler.

WINOLEAPI OleRegEnumVerbs(
  REFCLSID clsid,  //Class identifier
  LPENUMOLEVERB * ppenumOleVerb
                   //Address of output variable that receives the 
                   // IEnumOLEVERB interface pointer
);
 

Parameters

clsid

[in] Class identifier whose verbs are being requested.

ppenumOleVerb

[out] Address of IEnumOLEVERB* pointer variable that receives the interface pointer to the new enumeration object.

Return Values

This function supports the standard return value E_OUTOFMEMORY, as well as the following:

S_OK

The enumerator was created successfully.

OLEOBJ_E_NOVERBS

No verbs are registered for the class.

REGDB_E_CLASSNOTREG

No CLSID is registered for the class object.

REGDB_E_READREGDB

An error occurred reading the registry.

OLE_E_REGDB_KEY

The DataFormats/GetSet key is missing from the registry.

Remarks

Object applications can ask OLE to create an enumeration object for OLEVERB structures to enumerate supported verbs in one of two ways. One way is to call OleRegEnumVerbs. The other way is to return OLE_S_USEREG in response to calls by the default object handler to IOleObject::EnumVerbs. OLE_S_USEREG instructs the default handler to call OleRegEnumVerbs. Because DLL object applications cannot return OLE_S_USEREG, they must call OleRegEnumVerbs rather than delegating the job to the object handler. With the supplied IEnumOLEVERB pointer to the object, you can call the standard enumeration object methods to do the enumeration.

The OleRegEnumVerbs function and its sibling functions, OleRegGetUserType, OleRegGetMiscStatus, and OleRegEnumFormatEtc, provide a way for developers of custom DLL object applications to emulate the behavior of OLE's default object handler in getting information about objects from the registry. By using these functions, you avoid the considerable work of writing your own, and the pitfalls inherent in working directly in the registry. In addition, you get future enhancements and optimizations of these functions without having to code them yourself.

QuickInfo

  Windows NT: Use version 3.1 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in ole2.h.
  Import Library: Included as a resource in ole32.dll.

See Also

IOleObject::EnumVerbs, IEnumOLEVERB