WinCopyObject: Difference between revisions

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

Cdecl32

Example Code

HOBJECT hndlOriginalObject;
HOBJECT hndlDestinationObject;
APIRET  rc;
...
rc = WinCopyObject(hndlOriginalObject, hndlDestinationObject, 0L);
...

Related Functions

Notes

The REXX version of this function is SysCopyObject.

OS Version Introduced

OS/2 Warp 3.0

@@ Line 1: / Line 1: @@
-== WinCopyObject ==
+Copies object from its existing location to the destination location.
-; WinCopyObject(hndlOriginalObject, hndlDestinationObject, reserved) : Copies object from its existing location to the destination location.
-=== Parameters ===
+==Syntax==
-; hndlOriginalObject - [[HOBJECT]] - input : Handle of Workplace object being copied.
+ WinCopyObject (hndlOriginalObject, hndlDestinationObject, reserved)
-; hndlDestinationObject - HOBJECT - input : Handle of the destination folder where hndlOriginalObject will be copied.
-; reserved - [[ULONG]] - input : Must be set to zero, reserved paramter.
-=== 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
-=== Returns ===
+== Returns ==
 [[APIRET]] with values of:
 * [[HOBJECT]] - Newly copied object.
@@ Line 18: / Line 20: @@
 INCL_WINWORKPLACE
-=== Calling conversion ===
+== Calling Convention ==
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
   HOBJECT hndlOriginalObject;
   HOBJECT hndlDestinationObject;
@@ Line 29: / Line 31: @@
   ...
-=== Related Functions ===
+== Related Functions ==
 * [[WinCreateObject]]
 * [[WinDestroyObject]]
 * [[WinMoveObject]]
-* [[WinQueryObjectWindow]]
+* WinQueryObjectWindow
 * [[WinSaveObject]]
-=== Notes ===
+== Notes ==
-The REXX version of this function is [[SysCopyObject]].
+The REXX version of this function is ''SysCopyObject''.
-=== OS Version Introduced ===
+== OS Version Introduced ==
-*OS2 Warp 3.0
+*OS/2 Warp 3.0
 [[Category:Win]]