WinOpenObject: Difference between revisions
mNo edit summary |
|||
| Line 3: | Line 3: | ||
=== Parameters === | === Parameters === | ||
; objectHandle - [[HOBJECT]] - input : Handle of the object to open. | ;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. | ;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 : | ; flag - [[BOOL]] - input : | ||
* [[TRUE]] - Opens a view of the object which already exists by calling [[wpViewObject]], otherwise by calling [[wpOpen]]. | * [[TRUE]] - Opens a view of the object which already exists by calling [[wpViewObject]], otherwise by calling [[wpOpen]]. | ||
| Line 10: | Line 10: | ||
=== Constants === | === Constants === | ||
* | * OPEN_CONTENTS | ||
* | * OPEN_DEFAULTS | ||
* | * OPEN_DETAILS | ||
* | * OPEN_HELP | ||
* | * OPEN_RUNNING | ||
* | * OPEN_SETTINGS | ||
* | * OPEN_TREE | ||
=== Returns === | === Returns === | ||
Revision as of 23:06, 18 January 2017
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
- OPEN_CONTENTS
- OPEN_DEFAULTS
- OPEN_DETAILS
- OPEN_HELP
- OPEN_RUNNING
- OPEN_SETTINGS
- OPEN_TREE
Returns
True if successful, false if not successful.
Returns from WinGetLastError should WinOpenObject fail:
Define (C/C++)
INCL_WINWORKPLACE
Calling Convention
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