WinCreateShadow

Create a shadow of the specified object to the specified location.

Syntax

WinCreateShadow (hndlOfOriginObject, hndlOfDestinationFolder, reserved)

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

rc (HOBJECT) - returns

Handle of the newly created shadow object.

A return value of NULLHANDLE indicates that either hObjectofDest is NULLHANDLE or an object with the same name as hObjectofObject exists in the destination folder.

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.

Remarks

Using HOBJECT for .INI files or files in which an application uses a rename/save/delete sequence is not supported. Its REXX counterpart is SysCreateShadowObject.

Define (C/C++)

INCL_WINWORKPLACE

Calling Convention

Cdecl32

Example Code

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

Definition:

#define INCL_WINWORKPLACE
#include <os2.h>

HOBJECT    hObjectofObject;  /*  Handle of the object from which the shadow is to be created. */
HOBJECT    hObjectofDest;    /*  Handle of the folder into which hObjectofObject is to be placed. */
ULONG      ulReserved;       /*  Reserved value; must be 0. */
HOBJECT    rc;               /*  Handle of the newly created shadow object. */ 

rc = WinCreateShadow(hObjectofObject, hObjectofDest, ulReserved);

Related Functions

• WinCreateObject
• WinDestroyObject
• WinMoveObject
• WinQueryObjectWindow
• WinSaveObject

Notes

The REXX counter part to WinCreateShadow is SysCreateShadowObject.

OS Version Introduced

• OS/2 Warp 3.0