WinOpenObject: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 7: | Line 7: | ||
;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. | ||
:FALSE - Opens a view of the object by calling wpOpen. | |||
== Constants == | == Constants == | ||
| Line 22: | Line 21: | ||
== Returns == | == Returns == | ||
True if successful, false if not successful. | True if successful, false if not successful. | ||
* | * TRUE | ||
* | * FALSE | ||
Returns from [[WinGetLastError]] should '''WinOpenObject''' fail: | Returns from [[WinGetLastError]] should '''WinOpenObject''' fail: | ||
* [[ | * [[PM Error Codes#WPERR_OBJECT_NOT_FOUND|WPERR_OBJECT_NOT_FOUND]] | ||
* [[ | * [[PM Error Codes#WPERR_INVALID_FLAGS|WPERR_INVALID_FLAGS]] | ||
== Define (C/C++) == | == Define (C/C++) == | ||
Latest revision as of 14:07, 26 October 2025
Opens object with the specified view, or, if already open, surfaces it.
Syntax
WinOpenObject(objectHandle, viewForObject, flag)
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.
- TRUE
- FALSE
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