Jump to content

wpclsQueryObjectFromFrame

From EDM2
Revision as of 21:44, 25 May 2025 by Martini (talk | contribs) (Created page with "{{DISPLAYTITLE:wpclsQueryObjectFromFrame}} This method is specific to version 3, or higher, of the OS/2 operating system. This class method returns a pointer to the object associated with the specified frame window handle. ==Syntax== _wpclsQueryObjectFromFrame(somSelf, hwndFrame) ==Parameters== ;'''somSelf''' (M_WPDesktop *) - input :Pointer to the WPDesktop class object. ;'''hwndFrame''' (HWND) - input :Handle to the top-level frame window. ;'''Object''' (WPO...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This method is specific to version 3, or higher, of the OS/2 operating system. This class method returns a pointer to the object associated with the specified frame window handle.

Syntax

_wpclsQueryObjectFromFrame(somSelf, hwndFrame)

Parameters

somSelf (M_WPDesktop *) - input
Pointer to the WPDesktop class object.
hwndFrame (HWND) - input
Handle to the top-level frame window.
Object (WPObject *) - returns
Pointer to the object associated with hwndFrame. This parameter contains a pointer to the object of which its view has the given frame window handle as its top-level frame window handle. A return value of NULL indicates that either an associated object could not be found or an error occurred.

Returns

Object (WPObject *) - returns
Pointer to the object associated with hwndFrame. This parameter contains a pointer to the object of which its view has the given frame window handle as its top-level frame window handle. A return value of NULL indicates that either an associated object could not be found or an error occurred.

Remarks

This method returns the object for which the handle is a view rather than the application implementing the view.

For example, if the hwndFrame of a folder's view is passed in, this method returns the folder object. If the hwndFrame of the system editor is passed in, this method returns the object which is currently being viewed by the editor. In this case, if an associated object cannot be found, the system editor program object is returned. For instance, if the system editor is launched from the command line and its hwndFrame is passed in, the editor program object is returned.

How to Override

This method should not be overridden.

Usage

This method can be called at any time.

Related Methods