WinOpenObject: Difference between revisions
mNo edit summary |
m →Returns |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Opens object with the specified view, or, if already open, surfaces it. | |||
=== Parameters | ==Syntax== | ||
WinOpenObject(objectHandle, viewForObject, flag) | |||
== 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 | * [[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. | * [[FALSE]] - Opens a view of the object by calling wpOpen. | ||
== Constants == | |||
* OPEN_CONTENTS | * OPEN_CONTENTS | ||
* OPEN_DEFAULTS | * OPEN_DEFAULTS | ||
| Line 18: | Line 20: | ||
* OPEN_TREE | * OPEN_TREE | ||
== Returns == | |||
True if successful, false if not successful. | True if successful, false if not successful. | ||
* [[TRUE]] | * [[TRUE]] | ||
* [[FALSE]] | * [[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++) == | |||
INCL_WINWORKPLACE | INCL_WINWORKPLACE | ||
== Calling Convention == | |||
[[Cdecl32]] | [[Cdecl32]] | ||
== Example Code == | |||
... | ... | ||
HOBJECT objectHandle; | HOBJECT objectHandle; | ||
| Line 42: | Line 44: | ||
... | ... | ||
== Related Functions == | |||
*[[WinCreateObject]] | *[[WinCreateObject]] | ||
== Notes == | |||
If concurrent views are off, | If concurrent views are off, ''wpViewObject'' will resurface an existing object. | ||
The REXX counterpart is ''SysOpenObject''. | The REXX counterpart is ''SysOpenObject''. | ||
== OS Version Introduced == | |||
OS/2 Warp 3.0 | OS/2 Warp 3.0 | ||
[[Category:Win]] | [[Category:Win]] | ||
Latest revision as of 02:12, 1 December 2019
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.
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