WinCreateShadow: Difference between revisions

Newer edit →

Revision as of 05:05, 1 May 2006

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.

Module

Define (C/C++)

INCL_WINWORKPLACE

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

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

Related Functions

WinCreateObject WinDestoryObject WinMoveObject WinQueryObjectWindow WinSaveObject

Notes

The REXX counter part to WinCreateShadow is SysCreateShadowObject.

OS Version Introduced

OS/2 Warp 3.0

@@ Line 1: / Line 1: @@
 == WinCreateShadow ==
-; WinCreateShadow(hndlOfOriginObject, hndlOfDestinationFolder, reserved) :
+; WinCreateShadow(hndlOfOriginObject, hndlOfDestinationFolder, reserved) : Create a shadow of the specified object to the specified location.
-Create a shadow of the specified object to the specified location.
 === Parameters ===
-; hndlOfOriginObject - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input :
+; hndlOfOriginObject - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : Handle of the object from which the shadow will be created.
-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 - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input :
+; reserved - [[OS2 API:DataType:ULONG|ULONG]] - input : Reserved - must be zero.
-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.
 === Constants ===