WinCreateShadow: Difference between revisions

← Older edit Newer edit →

Revision as of 22:22, 10 November 2016

WinCreateShadow

WinCreateShadow(hndlOfOriginObject, hndlOfDestinationFolder, reserved): Create a shadow of the specified object to the specified location.

Parameters

hndlOfOriginObject - HOBJECT - input: Handle of the object from which the shadow will be created.
hndlOfDestinationFolder - HOBJECT - input: Handle of folder which the handle of the origin object is to be placed.
reserved - ULONG - input: Reserved - must be zero.

Constants

None

Returns

APIRET with values of:

The newly created handle of the shadow object.
NULLHANDLE : The destination folder is NULLHANDLE or an object already exists with the same name as hndlOfOriginObject.

Define (C/C++)

INCL_WINWORKPLACE

Calling conversion

Cdecl32

Example Code

HOBJECT hndlOfOriginObject;
HOBJECT hndlOfDestinationFolder;
APIRET  rc;
...
rc = WinCreateShadow(hndlOfOriginObject, hndlOfDestinationFolder, 0L);
...

Related Functions

Notes

The REXX counter part to WinCreateShadow is SysCreateShadowObject.

OS Version Introduced

OS/2 Warp 3.0

@@ Line 3: / Line 3: @@
 === Parameters ===
-; hndlOfOriginObject - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : Handle of the object from which the shadow will be created.
+; hndlOfOriginObject - [[HOBJECT]] - input : Handle of the object from which the shadow will be created.
-; hndlOfDestinationFolder - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : Handle of folder which the handle of the origin object is to be placed.
+; hndlOfDestinationFolder - HOBJECT - input : Handle of folder which the handle of the origin object is to be placed.
-; reserved - [[OS2 API:DataType:ULONG|ULONG]] - input : Reserved - must be zero.
+; reserved - [[ULONG]] - input : Reserved - must be zero.
 === Constants ===
@@ Line 11: / Line 11: @@
 === Returns ===
-[[OS2 API:DataType:APIRET|APIRET]] with values of:
+[[APIRET]] with values of:
 * The newly created handle of the shadow object.
-* [[OS2 API:DataType:NULLHANDLE|NULLHANDLE]] : The destination folder is [[OS2_API:DataType:NULLHANDLE|NULLHANDLE]] or an object already exists with the same name as hndlOfOriginObject.
+* [[NULLHANDLE]] : The destination folder is NULLHANDLE or an object already exists with the same name as ''hndlOfOriginObject''.
-=== Module ===
 === Define (C/C++) ===
 INCL_WINWORKPLACE
-=== Export name/Ordinal ===
 === Calling conversion ===
@@ Line 26: / Line 22: @@
 === Example Code ===
-  [[OS2 API:DataType:HOBJECT|HOBJECT]] hndlOfOriginObject;
+  HOBJECT hndlOfOriginObject;
-  [[OS2 API:DataType:HOBJECT|HOBJECT]] hndlOfDestinationFolder;
+  HOBJECT hndlOfDestinationFolder;
-  [[OS2 API:DataType:APIRET|APIRET]]   rc;
+  APIRET  rc;
   ...
   rc = WinCreateShadow(hndlOfOriginObject, hndlOfDestinationFolder, 0L);
@@ Line 34: / Line 30: @@
 === Related Functions ===
-[[OS2 API:WinCreateObject|WinCreateObject]]
+*[[WinCreateObject]]
-[[OS2 API:WinDestroyObject|WinDestoryObject]]
+*[[WinDestoryObject]]
-[[OS2 API:WinMoveObject|WinMoveObject]]
+*[[WinMoveObject]]
-[[OS2 API:WinQueryObjectWindow|WinQueryObjectWindow]]
+*[[WinQueryObjectWindow]]
-[[OS2 API:WinSaveObject|WinSaveObject]]
+*[[WinSaveObject]]
 === Notes ===
-The REXX counter part to [[OS2 API:WinCreateShadow|WinCreateShadow]] is [[OS2_API:SysCreateShadowObject|SysCreateShadowObject]].
+The REXX counter part to '''WinCreateShadow''' is [[SysCreateShadowObject]].
 === OS Version Introduced ===
-OS/2 Warp 3.0
+*OS/2 Warp 3.0
-[[OS2_API | Back to OS/2 API]]
-[[Category:The OS/2 API Project]]
+[[Category:Win]]