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 : Handle of the object to be moved.
+ WinMoveObject(moveObject, destinationObject, option)
-; 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 ==
+;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 ===
+== 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.
@@ Line 17: / Line 19: @@
 from OS/2 Warp Presentation Manager API book:
 . True if successful, false if not successful.
-* [[OS2 API:DataType:TRUE|TRUE]]
+* [[TRUE]]
-* [[OS2 API:DataType:FALSE|FALSE]]
+* [[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 ==
-=== Calling Convention ===
 [[Cdecl32]]
-=== Example Code ===
+== Example Code ==
   ...
   HOBJECT moveObject;
@@ Line 44: / Line 42: @@
   ...
-=== Related Functions ===
+== Related Functions ==
 *[[WinCreateObject]]
 *[[WinQueryObject]]
@@ Line 52: / Line 50: @@
 *[[WinSetObjectData]]
-=== Notes ===
+== Notes ==
-The REXX function is [[SysMoveObject]].
+The REXX function is ''SysMoveObject''.
-=== OS Version Introduced ===
+== OS Version Introduced ==
 *OS/2 Warp 3.0
 [[Category:Win]]