Skip to content

Latest commit

 

History

History
141 lines (106 loc) · 4.24 KB

nf-oleidl-ioleobject-getmiscstatus.md

File metadata and controls

141 lines (106 loc) · 4.24 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:oleidl.IOleObject.GetMiscStatus
IOleObject::GetMiscStatus (oleidl.h)
Retrieves the status of an object at creation and loading.
GetMiscStatus
GetMiscStatus method [COM]
GetMiscStatus method [COM]
IOleObject interface
IOleObject interface [COM]
GetMiscStatus method
IOleObject.GetMiscStatus
IOleObject::GetMiscStatus
_ole_ioleobject_getmiscstatus
com.ioleobject_getmiscstatus
oleidl/IOleObject::GetMiscStatus
com\ioleobject_getmiscstatus.htm
com
0c5e9f73-8eec-48e0-a172-4d3d49e56071
12/05/2018
GetMiscStatus, GetMiscStatus method [COM], GetMiscStatus method [COM],IOleObject interface, IOleObject interface [COM],GetMiscStatus method, IOleObject.GetMiscStatus, IOleObject::GetMiscStatus, _ole_ioleobject_getmiscstatus, com.ioleobject_getmiscstatus, oleidl/IOleObject::GetMiscStatus
oleidl.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
OleIdl.Idl
Windows
19H1
IOleObject::GetMiscStatus
oleidl/IOleObject::GetMiscStatus
c++
APIRef
kbSyntax
COM
OleIdl.h
IOleObject.GetMiscStatus

IOleObject::GetMiscStatus

-description

Retrieves the status of an object at creation and loading.

-parameters

-param dwAspect [in]

The aspect of an object about which status information is being requested. The value is obtained from the enumeration DVASPECT.

-param pdwStatus [out]

Pointer to where the status information is returned. This parameter cannot be NULL.

-returns

This method returns S_OK on success. Other possible return values include the following.

Return code Description
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 IOleObject::GetMiscStatus 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.

-see-also

DVASPECT

FORMATETC

IOleObject

OLEMISC