WinCopyObject: Difference between revisions
Appearance
No edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
== | Copies object from its existing location to the destination location. | ||
==Syntax== | |||
WinCopyObject (hndlOriginalObject, hndlDestinationObject, reserved) | |||
=== Parameters === | === Parameters === | ||
; hndlOriginalObject - [[HOBJECT]] - input : Handle of Workplace object being copied. | ;hndlOriginalObject - [[HOBJECT]] - input : Handle of Workplace object being copied. | ||
; hndlDestinationObject - HOBJECT - input : Handle of the destination folder where hndlOriginalObject will be copied. | ;hndlDestinationObject - HOBJECT - input : Handle of the destination folder where hndlOriginalObject will be copied. | ||
; reserved - [[ULONG]] - input : Must be set to zero, reserved paramter. | ; reserved - [[ULONG]] - input : Must be set to zero, reserved paramter. | ||
Line 33: | Line 35: | ||
* [[WinDestroyObject]] | * [[WinDestroyObject]] | ||
* [[WinMoveObject]] | * [[WinMoveObject]] | ||
* | * WinQueryObjectWindow | ||
* [[WinSaveObject]] | * [[WinSaveObject]] | ||
=== Notes === | === Notes === | ||
The REXX version of this function is | The REXX version of this function is ''SysCopyObject''. | ||
=== OS Version Introduced === | === OS Version Introduced === |
Revision as of 11:09, 4 March 2017
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