WinOpenObject: Difference between revisions

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.

TRUE
FALSE

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

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

@@ Line 1: / Line 1: @@
-== WinOpenObject ==
+Opens object with the specified view, or, if already open, surfaces it.
-; WinOpenObject(objectHandle, viewForObject, flag) : Opens object with the specified view, or, if already open, surfaces it.
-=== Parameters ===
+==Syntax==
-; objectHandle - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : Handle of the object to open.
+ WinOpenObject(objectHandle, viewForObject, flag)
-; viewForObject - [[OS2 API:DataType:ULONG|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 - [[OS2 API:DataType:BOOL|BOOL]] - input :
-* [[OS2 API:Constant:TRUE|TRUE]] - Opens a view of the object which already exists by calling [[OS2 API:wpViewObject|wpViewObject]], otherwise by calling [[OS2 API:wpOpen|wpOpen]].
-* [[OS2 API:Constant:FALSE|FALSE]] - Opens a view of the object by calling [[OS2 API:wpOpen|wpOpen]].
-=== Constants ===
+== Parameters ==
-* [[OS2 API:Constant:OPEN#OPEN_CONTENTS|OPEN_CONTENTS]]
+;objectHandle - [[HOBJECT]] - input : Handle of the object to open.
-* [[OS2 API:Constant:OPEN#OPEN_DEFAULT|OPEN_DEFAULTS]]
+;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.
-* [[OS2 API:Constant:OPEN#OPEN_DETAILS|OPEN_DETAILS]]
+; flag - [[BOOL]] - input :
-* [[OS2 API:Constant:OPEN#OPEN_HELP|OPEN_HELP]]
+* [[TRUE]] - Opens a view of the object which already exists by calling wpViewObject, otherwise by calling wpOpen.
-* [[OS2 API:Constant:OPEN#OPEN_RUNNING|OPEN_RUNNING]]
+* [[FALSE]] - Opens a view of the object by calling wpOpen.
-* [[OS2 API:Constant:OPEN#OPEN_SETTINGS|OPEN_SETTINGS]]
-* [[OS2 API:Constant:OPEN#OPEN_TREE|OPEN_TREE]]
-=== Returns ===
+== Constants ==
+* OPEN_CONTENTS
+* OPEN_DEFAULTS
+* OPEN_DETAILS
+* OPEN_HELP
+* OPEN_RUNNING
+* OPEN_SETTINGS
+* OPEN_TREE
+== Returns ==
 True if successful, false if not successful.
-* [[OS2 API:Constant:TRUE|TRUE]]
+* [[TRUE]]
-* [[OS2 API:Constant:FALSE|FALSE]]
+* [[FALSE]]
-Returns from [[OS2 API:WinGetLastError|WinGetLastError]] should [[OS2 API:WinOpenObject|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]]
-=== Module ===
-=== Define (C/C++) ===
+== Define (C/C++) ==
 INCL_WINWORKPLACE
-=== Export name/Ordinal ===
+== Calling Convention ==
-=== Calling conversion ===
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
   ...
-  [[OS2 API:DataType:HOBJECT|HOBJECT]] objectHandle;
+  HOBJECT objectHandle;
-  [[OS2 API:DataType:ULONG|ULONG]]   viewForObject;
+  ULONG   viewForObject;
-  [[OS2 API:DataType:BOOL|BOOL]]    flag;
+  BOOL    flag;
-  [[OS2 API:DataType:BOOL|BOOL]]    rc;
+  BOOL    rc;
   ...
   rc = WinOpenObject (objectHandle, viewForObject, flag);
   ...
-=== Related Functions ===
+== Related Functions ==
-[[OS2 API:WinCreateObject|WinCreateObject]]
+*[[WinCreateObject]]
+== Notes ==
+If concurrent views are off, ''wpViewObject'' will resurface an existing object.
+The REXX counterpart is ''SysOpenObject''.
-=== Notes ===
+== OS Version Introduced ==
-If concurrent views are off, [[OS2 API:wpViewObject|wpViewObject]] will resurface an existing object.
+OS/2 Warp 3.0
-The REXX counterpart is [[OS2 API:REXX:SysOpenObject|SysOpenObject]].
-=== OS Version Introduced ===
+[[Category:Win]]
-OS/2 Warp 3.0 and above, eCS 1.0 and above