WinCreateShadow: Difference between revisions
Appearance
mNo edit summary |
mNo edit summary |
||
Line 4: | Line 4: | ||
WinCreateShadow (hndlOfOriginObject, hndlOfDestinationFolder, reserved) | WinCreateShadow (hndlOfOriginObject, hndlOfDestinationFolder, reserved) | ||
== Parameters == | |||
; hndlOfOriginObject - [[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 - 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 - [[ULONG]] - input : Reserved - must be zero. | ; reserved - [[ULONG]] - input : Reserved - must be zero. | ||
== Constants == | |||
None | None | ||
== Returns == | |||
[[APIRET]] with values of: | [[APIRET]] with values of: | ||
* The newly created handle of the shadow object. | * 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''. | * [[NULLHANDLE]] : The destination folder is NULLHANDLE or an object already exists with the same name as ''hndlOfOriginObject''. | ||
== Define (C/C++) == | |||
INCL_WINWORKPLACE | INCL_WINWORKPLACE | ||
== Calling Convention == | |||
[[Cdecl32]] | [[Cdecl32]] | ||
== Example Code == | |||
HOBJECT hndlOfOriginObject; | HOBJECT hndlOfOriginObject; | ||
HOBJECT hndlOfDestinationFolder; | HOBJECT hndlOfDestinationFolder; | ||
Line 31: | Line 31: | ||
... | ... | ||
== Related Functions == | |||
*[[WinCreateObject]] | *[[WinCreateObject]] | ||
*[[WinDestroyObject]] | *[[WinDestroyObject]] | ||
Line 38: | Line 38: | ||
*[[WinSaveObject]] | *[[WinSaveObject]] | ||
== Notes == | |||
The REXX counter part to '''WinCreateShadow''' is ''SysCreateShadowObject''. | The REXX counter part to '''WinCreateShadow''' is ''SysCreateShadowObject''. | ||
== OS Version Introduced == | |||
*OS/2 Warp 3.0 | *OS/2 Warp 3.0 | ||
[[Category:Win]] | [[Category:Win]] |
Revision as of 04:50, 20 May 2018
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
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