IOleObject::GetMiscStatus

Returns a value indicating the status of an object at creation and loading.

HRESULT GetMiscStatus(
  DWORD dwAspect,  //Value indicating object aspect
  DWORD *pdwStatus //Pointer to storage of status information
);

Parameters

dwAspect: [in] Value indicating the aspect of an object about which status information is being requested. The value is obtained from the enumeration DVASPECT (see "FORMATETC Data Structure").
pdwStatus: [out] Pointer to where the status information is returned. May not be NULL.

Return Values

S_OK: Status information returned successfully.
OLE_S_USEREG: Delegate the retrieval of miscellaneous status information to the default handler's implementation of this method.
CO_E_CLASSNOTREG: There is no CLSID registered for the object.
CO_E_READREGDB: Error accessing the registry.

Remarks

A container normally calls IOleObject::GetMiscStatus when it creates or loads an object in order to determine how to display the object and what types of behaviors it supports.

Objects store status information in the registry. If the object is not running, the default handler's implementation of IOleObject::GetMiscStatus retrieves this information from the registry. If the object is running, the default handler invokes IOleObject::GetMiscStatus on the object itself.

The information that is actually stored in the registry varies with individual objects. The status values to be returned are defined in the enumeration OLEMISC.

The default value of MiscStatus is used if a subkey corresponding to the specified DVASPECT is not found. To set an OLE control, specify DVASPECT==1. This will cause the following to occur in the Registry:

HKEY_CLASSES_ROOT\CLSID\ . . .\MiscStatus = 1

Notes to Implementers

Implementation normally consists of delegating the call to the default handler.

QuickInfo

  Windows NT: Use version 3.1 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in oleidl.h.