WinCreateShadow: Difference between revisions
| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
== Parameters == | == Parameters == | ||
; hndlOfOriginObject | ; hndlOfOriginObject ([[HOBJECT]]) - input : Handle of the object from which the shadow will be created. | ||
; hndlOfDestinationFolder | ; hndlOfDestinationFolder (HOBJECT) - input : Handle of folder which the handle of the origin object is to be placed. | ||
; reserved | ; reserved ([[ULONG]]) - input : Reserved - must be zero. | ||
== Constants == | == Constants == | ||
| Line 20: | Line 20: | ||
* 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''. | ||
==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++) == | == Define (C/C++) == | ||
| Line 34: | Line 37: | ||
rc = WinCreateShadow(hndlOfOriginObject, hndlOfDestinationFolder, 0L); | 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 == | == Related Functions == | ||
| Line 39: | Line 54: | ||
*[[WinDestroyObject]] | *[[WinDestroyObject]] | ||
*[[WinMoveObject]] | *[[WinMoveObject]] | ||
*WinQueryObjectWindow | *[[WinQueryObjectWindow]] | ||
*[[WinSaveObject]] | *[[WinSaveObject]] | ||
Latest revision as of 19:31, 14 May 2025
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
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
Notes
The REXX counter part to WinCreateShadow is SysCreateShadowObject.
OS Version Introduced
- OS/2 Warp 3.0