nf-oleidl-ioleinplaceobject-inplacedeactivate.md

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.IOleInPlaceObject.InPlaceDeactivate	IOleInPlaceObject::InPlaceDeactivate (oleidl.h)	Deactivates an active in-place object and discards the object's undo state.	IOleInPlaceObject interface [COM] InPlaceDeactivate method IOleInPlaceObject.InPlaceDeactivate IOleInPlaceObject::InPlaceDeactivate InPlaceDeactivate InPlaceDeactivate method [COM] InPlaceDeactivate method [COM] IOleInPlaceObject interface _ole_ioleinplaceobject_inplacedeactivate com.ioleinplaceobject_inplacedeactivate oleidl/IOleInPlaceObject::InPlaceDeactivate	com\ioleinplaceobject_inplacedeactivate.htm	com	174a8bde-0795-4d4d-a294-7708c7d1823a	12/05/2018	IOleInPlaceObject interface [COM],InPlaceDeactivate method, IOleInPlaceObject.InPlaceDeactivate, IOleInPlaceObject::InPlaceDeactivate, InPlaceDeactivate, InPlaceDeactivate method [COM], InPlaceDeactivate method [COM],IOleInPlaceObject interface, _ole_ioleinplaceobject_inplacedeactivate, com.ioleinplaceobject_inplacedeactivate, oleidl/IOleInPlaceObject::InPlaceDeactivate	oleidl.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]					OleIdl.Idl								Windows			19H1	IOleInPlaceObject::InPlaceDeactivate oleidl/IOleInPlaceObject::InPlaceDeactivate	c++	APIRef kbSyntax	COM	OleIdl.h	IOleInPlaceObject.InPlaceDeactivate

IOleInPlaceObject::InPlaceDeactivate

-description

Deactivates an active in-place object and discards the object's undo state.

-returns

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

Return code	Description
E_UNEXPECTED	An unexpected error occurred.

-remarks

Notes to Callers

This method is called by an active object's immediate container to deactivate the active object and discard its undo state.

Notes to Implementers

On return from IOleInPlaceObject::InPlaceDeactivate, the object discards its undo state. The object application should not shut down immediately after this call. Instead, it should wait for an explicit call to IOleObject::Close or for the object's reference count to reach zero.

Before deactivating, the object application should give the container a chance to put its user interface back on the frame window by calling IOleInPlaceSite::OnUIDeactivate.

If the in-place user interface is still visible during the call to IOleInPlaceObject::InPlaceDeactivate, the object application should call its own IOleInPlaceObject::InPlaceDeactivate method to hide the user interface. The in-place user interface can be optionally destroyed during calls to IOleInPlaceObject::InPlaceDeactivate and IOleInPlaceObject::InPlaceDeactivate. But if the user interface has not already been destroyed when the container calls IOleObject::Close, then it must be destroyed during the call to IOleObject::Close.

During the call to IOleObject::Close, the object should check to see whether it is still active in place. If so, it should call IOleInPlaceObject::InPlaceDeactivate.

-see-also

IOleInPlaceObject

IOleInPlaceSite::OnInPlaceDeactivate

IOleInPlaceSite::OnUIDeactivate

IOleObject::Close