Share via


IOleClientSite::OnShowWindow

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

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 Value

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 added or removed.

Remarks

An embedded object calls OnShowWindow to keep its container informed when the object is open in a window. This window might or might not be visible to the 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 has an open window and therefore can respond to being double-clicked by bringing this window to the top, instead of launching its application to obtain a new one.

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

Requirements

Header Oleidl.h, oleidl.idl
Library oleaut32.lib, uuid.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

IOleClientSite

Concepts

Determining Supported COM APIs