WinCopyObject: Difference between revisions

← Older edit Newer edit →

Revision as of 22:17, 10 November 2016

WinCopyObject

WinCopyObject(hndlOriginalObject, hndlDestinationObject, reserved): Copies object from its existing location to the destination location.

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 conversion

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

OS2 Warp 3.0

@@ Line 3: / Line 3: @@
 === Parameters ===
-; hndlOriginalObject - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : Handle of Workplace object being copied.
+; hndlOriginalObject - [[HOBJECT]] - input : Handle of Workplace object being copied.
-; hndlDestinationObject - [[OS2 API:DataType:HOBJECT|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 - [[OS2 API:DataType:ULONG|ULONG]] - input : Must be set to zero, reserved paramter.
+; reserved - [[ULONG]] - input : Must be set to zero, reserved paramter.
 === Constants ===
@@ Line 11: / Line 11: @@
 === Returns ===
-[[OS2 API:DataType:APIRET|APIRET]] with values of:
+[[APIRET]] with values of:
-* [[OS2 API:DataType:HOBJECT|HOBJECT]] - Newly copied object.
+* [[HOBJECT]] - Newly copied object.
-* [[OS2 API:DataType:NULLHANDLE|NULLHANDLE]] - If pre-existing or destination folder is [[OS2 API:DataType:NULLHANDLE|NULLHANDLE]].
+* [[NULLHANDLE]] - If pre-existing or destination folder is NULLHANDLE.
-=== Module ===
 === Define (C/C++) ===
 INCL_WINWORKPLACE
-=== Export name/Ordinal ===
 === Calling conversion ===
@@ Line 26: / Line 22: @@
 === Example Code ===
-  [[OS2 API:DataType:HOBJECT|HOBJECT]] hndlOriginalObject;
+  HOBJECT hndlOriginalObject;
-  [[OS2 API:DataType:HOBJECT|HOBJECT]] hndlDestinationObject;
+  HOBJECT hndlDestinationObject;
-  [[OS2 API:DataType:APIRET|APIRET]] rc;
+  APIRET  rc;
   ...
   rc = WinCopyObject(hndlOriginalObject, hndlDestinationObject, 0L);
@@ Line 34: / Line 30: @@
 === Related Functions ===
-* [[OS2 API:WinCreateObject|WinCreateObject]]
+* [[WinCreateObject]]
-* [[OS2 API:WinDestroyObject|WinDestroyObject]]
+* [[WinDestroyObject]]
-* [[OS2 API:WinMoveObject|WinMoveObject]]
+* [[WinMoveObject]]
-* [[OS2 API:WinQueryObjectWindow|WinQueryObjectWindow]]
+* [[WinQueryObjectWindow]]
-* [[OS2 API:WinSaveObject|WinSaveObject]]
+* [[WinSaveObject]]
 === Notes ===
-The REXX version of this function is [[OS2 API:SysCopyObject|SysCopyObject]].
+The REXX version of this function is [[SysCopyObject]].
 === OS Version Introduced ===
-OS2 Warp 3.0
+*OS2 Warp 3.0
-[[Category:The OS/2 API Project]]
+[[Category:Win]]