WinMoveObject: Difference between revisions

Latest revision as of 19:33, 14 May 2025

Moves an object from one location to the desired location.

Syntax

WinMoveObject(moveObject, destinationObject, option)

Parameters

moveObject (HOBJECT) - input: Handle of the object to be moved.
destinationObject (HOBJECT) - input: Handle of the destination folder to move the moveObject into.
option (ULONG) - input: The only supported option is CO_FAILIFEXISTS.

Constants

CO_FAILIFEXISTS

Returns

HOBJECT of the object moved or NULLHANDLE if the object exists already exists or the current object's handle is NULLHANDLE. Returns from WinGetLastError should WinMoveObject fail:

Define (C/C++)

INCL_WINWORKPLACE

Calling Convention

Cdecl32

Example Code

...
HOBJECT moveObject;
HOBJECT destinationObject;
ULONG option;
HOBJECT rc;
...
rc = WinMoveObject (moveObject, destinationObject, option);
...

Related Functions

Notes

The REXX function is SysMoveObject.

OS Version Introduced

OS/2 Warp 3.0

@@ Line 1: / Line 1: @@
-== WinMoveObject ==
+Moves an object from one location to the desired location.
-; WinMoveObject(moveObject, destinationObject, option) :
-Moves object from one location to the desired location.
-=== Parameters ===
+==Syntax==
-; moveObject - [[HOBJECT]] - input :
+ WinMoveObject(moveObject, destinationObject, option)
-Handle of the object to be moved.
-; destinationObject - [[HOBJECT]] - input :
-Handle of the destination folder to move the moveObject into.
-; option - [[ULONG]] - input :
-The only supported option is [[CO_FAILIFEXISTS]].
-=== Constants ===
+== Parameters ==
-* [[CO_FAILIFEXISTS]]
+;moveObject ([[HOBJECT]]) - input : Handle of the object to be moved.
+;destinationObject ([[HOBJECT]]) - input : Handle of the destination folder to move the moveObject into.
+;option ([[ULONG]]) - input : The only supported option is CO_FAILIFEXISTS.
-=== Returns ===
+== Constants ==
+*CO_FAILIFEXISTS
+== Returns ==
 <!-- From the toolkit API doc: -->
-[[HOBJECT]] of the object moved or [[NULLHANDLE]] if the object exists already exists or the current object's handle is [[NULLHANDLE]].
+[[HOBJECT]] of the object moved or [[NULLHANDLE]] if the object exists already exists or the current object's handle is NULLHANDLE.
 <!--
 OR
@@ Line 24: / Line 22: @@
 * [[FALSE]]
 -->
-Returns from [[WinGetLastError]] should [[WinMoveObject]] fail:
+Returns from [[WinGetLastError]] should WinMoveObject fail:
-* [[OS2_API:PMI:error#WPERR_ALREADY_EXISTS|WPERR_ALREADY_EXISTS]]
+* [[PM Error Codes#WPERR_ALREADY_EXISTS|WPERR_ALREADY_EXISTS]]
-* [[OS2_API:PMI:error#WPERR_INVALID_FLAGS|WPERR_INVALID_FLAGS]]
+* [[PM Error Codes#WPERR_INVALID_FLAGS|WPERR_INVALID_FLAGS]]
-=== Module ===
-=== Define (C/C++) ===
+== Define (C/C++) ==
 INCL_WINWORKPLACE
-=== Export name/Ordinal ===
+== Calling Convention ==
+[[Cdecl32]]
-=== Calling conversion ===
+== Example Code ==
-[[Cdecl32]]
+ ...
+ HOBJECT moveObject;
+ HOBJECT destinationObject;
+ ULONG option;
+ HOBJECT rc;
+ ...
+ rc = WinMoveObject (moveObject, destinationObject, option);
+ ...
-=== Example Code ===
+== Related Functions ==
-...<br>
+*[[WinCreateObject]]
-[[HOBJECT]] moveObject;<br>
+*[[WinQueryObject]]
-[[HOBJECT]] destinationObject;<br>
+*[[WinCopyObject]]
-[[ULONG]] option;<br>
+*[[WinSaveObject]]
-[[HOBJECT]] rc;<br>
+*[[WinOpenObject]]
-...<br>
+*[[WinSetObjectData]]
-rc = WinMoveObject (moveObject, destinationObject, option);<br>
-...<br>
-=== Related Functions ===
+== Notes ==
-[[WinCreateObject]]
+The REXX function is ''SysMoveObject''.
-[[WinQueryObject]]
-[[WinCopyObject]]
-[[WinSaveObject]]
-[[WinOpenObject]]
-[[WinSetObjectData]]
-=== Notes ===
+== OS Version Introduced ==
-The REXX function is [[SysMoveObject]].
+*OS/2 Warp 3.0
-=== OS Version Introduced ===
+[[Category:Win]]
-OS/2 Warp 3.0 and above, eCS 1.0 and above