IOleClientSite::OnShowWindow

  • Article

This method notifies container when an object becomes visible or invisible.

HRESULT OnShowWindow( 
  BOOL fShow
);

Parameters

  • fShow
    [in] Boolean value that is set to TRUE if an object's window is open, or set to FALSE if it is closed.

Return Values

This method supports the standard return values E_FAIL and E_UNEXPECTED, as well as the value S_OK that indicates that shading or hatching has been successfully added or removed.

Remarks

An embedded object calls OnShowWindow to keep its container informed when the object is open in a window. This window may or may not be currently visible to the end user. The container uses this information to shade the object's client site when the object is displayed in a window, and to remove the shading when the object is not. A shaded object, having received this notification, knows that it already has an open window and therefore can respond to being double-clicked by bringing this window quickly to the top, instead of launching its application in order to obtain a new one.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Oleidl.h, Oleidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.

See Also

IOleClientSite | Determining Supported COM APIs

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.