WinCreateShadow: Difference between revisions
Appearance
mNo edit summary |
|||
Line 13: | Line 13: | ||
== Returns == | == 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: | [[APIRET]] with values of: | ||
* The newly created handle of the shadow object. | * The newly created handle of the shadow object. |
Revision as of 22:50, 14 May 2023
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.
Define (C/C++)
INCL_WINWORKPLACE
Calling Convention
Example Code
HOBJECT hndlOfOriginObject; HOBJECT hndlOfDestinationFolder; APIRET rc; ... rc = WinCreateShadow(hndlOfOriginObject, hndlOfDestinationFolder, 0L); ...
Related Functions
- WinCreateObject
- WinDestroyObject
- WinMoveObject
- WinQueryObjectWindow
- WinSaveObject
Notes
The REXX counter part to WinCreateShadow is SysCreateShadowObject.
OS Version Introduced
- OS/2 Warp 3.0