IOleWindow::GetWindow
Returns the
window handle to one of the windows participating in in-place activation
(frame, document, parent, or in-place object window).
HRESULT GetWindow(
|
HWND * phwnd |
//Pointer to where to return window handle |
|
); |
|
Parameter
phwnd
[out] Pointer
to where to return the window handle.
Return Values
This method
supports the standard return values E_FAIL, E_OUTOFMEMORY, E_INVALIDARG, and
E_UNEXPECTED, as well as the following:
S_OK
The window
handle was successfully returned.
Note For windowless
objects, this method should always fail and return E_FAIL.
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:
|
Window |
Description |
|
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.