WinCopyObject: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 5: | Line 5: | ||
== Parameters == | == Parameters == | ||
;hndlOriginalObject | ;hndlOriginalObject ([[HOBJECT]]) - input : Handle of Workplace object being copied. | ||
;hndlDestinationObject | ;hndlDestinationObject (HOBJECT) - input : Handle of the destination folder where hndlOriginalObject will be copied. | ||
; reserved | ; reserved ([[ULONG]]) - input : Must be set to zero, reserved parameter. | ||
== Constants == | == Constants == | ||
| Line 14: | Line 14: | ||
== Returns == | == Returns == | ||
[[APIRET]] with values of: | [[APIRET]] with values of: | ||
* | *HOBJECT - Newly copied object. | ||
* [[NULLHANDLE]] - If pre-existing or destination folder is NULLHANDLE. | *[[NULLHANDLE]] - If pre-existing or destination folder is NULLHANDLE. | ||
=== Define (C/C++) === | === Define (C/C++) === | ||
Latest revision as of 16:33, 26 October 2025
Copies object from its existing location to the destination location.
Syntax
WinCopyObject (hndlOriginalObject, hndlDestinationObject, reserved)
Parameters
- hndlOriginalObject (HOBJECT) - input
- Handle of Workplace object being copied.
- hndlDestinationObject (HOBJECT) - input
- Handle of the destination folder where hndlOriginalObject will be copied.
- reserved (ULONG) - input
- Must be set to zero, reserved parameter.
Constants
None
Returns
APIRET with values of:
- HOBJECT - Newly copied object.
- NULLHANDLE - If pre-existing or destination folder is NULLHANDLE.
Define (C/C++)
INCL_WINWORKPLACE
Calling Convention
Example Code
HOBJECT hndlOriginalObject; HOBJECT hndlDestinationObject; APIRET rc; ... rc = WinCopyObject(hndlOriginalObject, hndlDestinationObject, 0L); ...
Related Functions
- WinCreateObject
- WinDestroyObject
- WinMoveObject
- WinQueryObjectWindow
- WinSaveObject
Notes
The REXX version of this function is SysCopyObject.
OS Version Introduced
- OS/2 Warp 3.0