OleRegGetUserType

Gets the user type of the specified class from the registry. Developers of custom DLL object applications use this function to emulate the behavior of the OLE default handler.

WINOLEAPI OleRegGetUserType(
  REFCLSID clsid,         //Class identifier
  DWORD dwFormOfType,     //Specifies form of type name
  LPOLESTR * pszUserType  //Pointer to storage of string pointer
);
 

Parameters

clsid

[in] Class identifier for which user type is requested.

dwFormOfType

[in] Value that describes the form of the user-presentable string from the enumeration USERCLASSTYPE.

pszUserType

[out] Pointer to a string that stores the user type on return.

Return Values

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

S_OK

The user type was returned successfully.

REGDB_E_CLASSNOTREG

There is no CLSID registered for the class object.

REGDB_E_READREGDB

There was an error reading the registry.

OLE_E_REGDB_KEY

The ProgID = MainUserTypeName and CLSID = MainUserTypeName keys are missing from the registry.

Remarks

Object applications can ask OLE to get the user type name of a specified class in one of two ways. One way is to call OleRegGetUserType. The other is to return OLE_S_USEREG in response to calls by the default object handler to IOleObject::GetUserType. OLE_S_USEREG instructs the default handler to call OleRegGetUserType. Because DLL object applications cannot return OLE_S_USEREG, they must call OleRegGetUserType, rather than delegating the job to the object handler.

The OleRegGetUserType function and its sibling functions, OleRegGetMiscStatus, OleRegEnumFormatEtc, and OleRegEnumVerbs, 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::GetUserType, OleRegGetMiscStatus, OleRegEnumFormatEtc, OleRegEnumVerbs, USERCLASSTYPE