WinCopyObject: Difference between revisions
Appearance
WinCopyObject created. |
|||
(12 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
Copies object from its existing location to the destination location. | Copies object from its existing location to the destination location. | ||
== | ==Syntax== | ||
WinCopyObject (hndlOriginalObject, hndlDestinationObject, reserved) | |||
=== Constants | == 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 paramter. | |||
== Constants == | |||
None | None | ||
== Returns == | |||
[[ | [[APIRET]] with values of: | ||
* [[ | * [[HOBJECT]] - Newly copied object. | ||
* [[ | * [[NULLHANDLE]] - If pre-existing or destination folder is NULLHANDLE. | ||
=== Define (C/C++) === | === Define (C/C++) === | ||
INCL_WINWORKPLACE | INCL_WINWORKPLACE | ||
== Calling Convention == | |||
[[Cdecl32]] | [[Cdecl32]] | ||
== Example Code == | |||
HOBJECT hndlOriginalObject; | |||
HOBJECT hndlDestinationObject; | |||
APIRET rc; | |||
... | ... | ||
rc = WinCopyObject(hndlOriginalObject, hndlDestinationObject, 0L); | 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 | |||
[[Category:Win]] | |||
Latest revision as of 19:56, 7 April 2024
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 paramter.
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