WinOpenObject: Difference between revisions
WinOpenObject created. |
No edit summary |
||
| Line 13: | Line 13: | ||
=== Constants === | === Constants === | ||
* OPEN_CONTENTS | * [[OPEN_CONTENTS]] | ||
* OPEN_DEFAULT | * [[OPEN_DEFAULT]] | ||
* OPEN_DETAILS | * [[OPEN_DETAILS]] | ||
* OPEN_HELP | * [[OPEN_HELP]] | ||
* OPEN_RUNNING | * [[OPEN_RUNNING]] | ||
* OPEN_SETTINGS | * [[OPEN_SETTINGS]] | ||
* OPEN_TREE | * [[OPEN_TREE]] | ||
=== Returns === | === Returns === | ||
| Line 26: | Line 26: | ||
* [[FALSE]] | * [[FALSE]] | ||
Returns from [[WinGetLastError]] should [[WinOpenObject]] fail: | Returns from [[WinGetLastError]] should [[WinOpenObject]] fail: | ||
* WPERR_OBJECT_NOT_FOUND | * [[WPERR_OBJECT_NOT_FOUND]] | ||
* WPERR_INVALID_FLAGS | * [[WPERR_INVALID_FLAGS]] | ||
=== Module === | === Module === | ||
Revision as of 08:07, 8 April 2005
WinOpenObject
- WinOpenObject(objectHandle, viewForObject, flag)
Opens object with the specified view, or, if already open, surfaces it.
Parameters
- objectHandle - HOBJECT - input
Handle of the object to open.
- viewForObject - ULONG - input
Specifies which view to open. An object can define its own view codes. The system defines those listed in the constants section.
- flag - BOOL - input
- TRUE - Opens a view of the object which already exists by calling wpViewObject, otherwise by calling wpOpen.
- FALSE - Opens a view of the object by calling wpOpen.
Constants
Returns
True if successful, false if not successful.
Returns from WinGetLastError should WinOpenObject fail:
Module
Define (C/C++)
INCL_WINWORKPLACE
Export name/Ordinal
Calling conversion
Example Code
...
HOBJECT objectHandle;
ULONG viewForObject;
BOOL flag;
BOOL rc;
...
rc = WinOpenObject (objectHandle, viewForObject, flag);
...
Related Functions
Notes
If concurrent views are off, wpViewObject will resurface an existing object. The REXX counterpart is SysOpenObject.
OS Version Introduced
OS/2 Warp 3.0 and above, eCS 1.0 and above