Jump to content

WinOpenObject: Difference between revisions

From EDM2
mNo edit summary
 
Line 25: Line 25:
* [[FALSE]]
* [[FALSE]]
Returns from [[WinGetLastError]] should '''WinOpenObject''' fail:
Returns from [[WinGetLastError]] should '''WinOpenObject''' fail:
* [[OS2_API:PMI:error#WPERR_OBJECT_NOT_FOUND|WPERR_OBJECT_NOT_FOUND]]
* [[PM Error Codes#WPERR_OBJECT_NOT_FOUND|WPERR_OBJECT_NOT_FOUND]]
* [[OS2_API:PMI:error#WPERR_INVALID_FLAGS|WPERR_INVALID_FLAGS]]
* [[PM Error Codes#WPERR_INVALID_FLAGS|WPERR_INVALID_FLAGS]]


== Define (C/C++) ==
== Define (C/C++) ==

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

Cdecl32

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