WinOpenObject: Difference between revisions
corrected links to namespace version. |
m changed namespace links. |
||
| Line 13: | Line 13: | ||
=== Constants === | === Constants === | ||
* [[OS2 API:Constant#OPEN_CONTENTS|OPEN_CONTENTS]] | * [[OS2 API:Constant:OPEN#OPEN_CONTENTS|OPEN_CONTENTS]] | ||
* [[OS2 API:Constant#OPEN_DEFAULT|OPEN_DEFAULTS]] | * [[OS2 API:Constant:OPEN#OPEN_DEFAULT|OPEN_DEFAULTS]] | ||
* [[OS2 API:Constant#OPEN_DETAILS|OPEN_DETAILS]] | * [[OS2 API:Constant:OPEN#OPEN_DETAILS|OPEN_DETAILS]] | ||
* [[OS2 API:Constant#OPEN_HELP|OPEN_HELP]] | * [[OS2 API:Constant:OPEN#OPEN_HELP|OPEN_HELP]] | ||
* [[OS2 API:Constant#OPEN_RUNNING|OPEN_RUNNING]] | * [[OS2 API:Constant:OPEN#OPEN_RUNNING|OPEN_RUNNING]] | ||
* [[OS2 API:Constant#OPEN_SETTINGS|OPEN_SETTINGS]] | * [[OS2 API:Constant:OPEN#OPEN_SETTINGS|OPEN_SETTINGS]] | ||
* [[OS2 API:Constant#OPEN_TREE|OPEN_TREE]] | * [[OS2 API:Constant:OPEN#OPEN_TREE|OPEN_TREE]] | ||
=== Returns === | === Returns === | ||
Revision as of 20:40, 10 May 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