WinCopyObject: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 9: | Line 9: | ||
; reserved - [[ULONG]] - input : Must be set to zero, reserved paramter. | ; reserved - [[ULONG]] - input : Must be set to zero, reserved paramter. | ||
== Constants == | |||
None | None | ||
== Returns == | |||
[[APIRET]] with values of: | [[APIRET]] with values of: | ||
* [[HOBJECT]] - Newly copied object. | * [[HOBJECT]] - Newly copied object. | ||
| Line 20: | Line 20: | ||
INCL_WINWORKPLACE | INCL_WINWORKPLACE | ||
== Calling Convention == | |||
[[Cdecl32]] | [[Cdecl32]] | ||
== Example Code == | |||
HOBJECT hndlOriginalObject; | HOBJECT hndlOriginalObject; | ||
HOBJECT hndlDestinationObject; | HOBJECT hndlDestinationObject; | ||
| Line 31: | Line 31: | ||
... | ... | ||
== Related Functions == | |||
* [[WinCreateObject]] | * [[WinCreateObject]] | ||
* [[WinDestroyObject]] | * [[WinDestroyObject]] | ||
| Line 38: | Line 38: | ||
* [[WinSaveObject]] | * [[WinSaveObject]] | ||
== Notes == | |||
The REXX version of this function is ''SysCopyObject''. | The REXX version of this function is ''SysCopyObject''. | ||
== OS Version Introduced == | |||
*OS2 Warp 3.0 | *OS2 Warp 3.0 | ||
[[Category:Win]] | [[Category:Win]] | ||
Revision as of 04:47, 20 May 2018
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
- OS2 Warp 3.0