Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IOleWindow::GetWindow method

Retrieves a handle to one of the windows participating in in-place activation (frame, document, parent, or in-place object window).

Syntax


HRESULT GetWindow(
  [out]  HWND *phwnd
);

Parameters

phwnd [out]

A pointer to a variable that receives the window handle.

Return value

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

Return codeDescription
E_FAIL

The object is windowless.

E_INVALIDARG

The specified fEnterMode value is not valid.

E_OUTOFMEMORY

There is insufficient memory available for this operation.

E_UNEXPECTED

An unexpected error has occurred.

 

Remarks

Five types of windows comprise the windows hierarchy. When a object is active in place, it has access to some or all of these windows.

WindowDescription

Frame

The outermost main window where the container application's main menu resides.

Document

The window that displays the compound document containing the embedded object to the user.

Pane

The subwindow of the document window that contains the object's view. Applicable only for applications with split-pane windows.

Parent

The container window that contains that object's view. The object application installs its window as a child of this window.

In-place

The window containing the active in-place object. The object application creates this window and installs it as a child of its hatch window, which is a child of the container's parent window.

 

Each type of window has a different role in the in-place activation architecture. However, it is not necessary to employ a separate physical window for each type. Many container applications use the same window for their frame, document, pane, and parent windows.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleIdl.h

IDL

OleIdl.Idl

IID

IID_IOleWindow is defined as 00000114-0000-0000-C000-000000000046

See also

IOleWindow

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.