WinOpenObject

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_DEFAULT
• 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:

• WPERR_OBJECT_NOT_FOUND
• WPERR_INVALID_FLAGS

Define (C/C++)

INCL_WINWORKPLACE

Calling conversion

Cdecl32

Example Code

...
HOBJECT objectHandle;
ULONG viewForObject;
BOOL flag;
BOOL rc;
...
rc = WinOpenObject (objectHandle, viewForObject, flag);
...

Related Functions

WinCreateObject

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