WinMoveObject: Difference between revisions

← Older edit Newer edit →

Revision as of 22:02, 10 November 2016

WinMoveObject

WinMoveObject(moveObject, destinationObject, option): Moves object from one location to the desired location.

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:

Module

Define (C/C++)

INCL_WINWORKPLACE

Export name/Ordinal

Calling conversion

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 3: / Line 3: @@
 === Parameters ===
-; moveObject - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : Handle of the object to be moved.
+; moveObject - [[HOBJECT]] - input : Handle of the object to be moved.
-; destinationObject - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : Handle of the destination folder to move the moveObject into.
+; destinationObject - [[HOBJECT]] - input : Handle of the destination folder to move the moveObject into.
-; option - [[OS2 API:DataType:ULONG|ULONG]] - input : The only supported option is [[OS2 API:Constant:CO#CO_FAILIFEXISTS|CO_FAILIFEXISTS]].
+; option - [[ULONG]] - input : The only supported option is [[CO_FAILIFEXISTS]].
 === Constants ===
-* [[OS2 API:Constant:CO#CO_FAILIFEXISTS|CO_FAILIFEXISTS]]
+*CO_FAILIFEXISTS
 === Returns ===
 <!-- From the toolkit API doc: -->
-[[OS2 API:DataType:HOBJECT|HOBJECT]] of the object moved or [[OS2 API:DataType:NULLHANDLE|NULLHANDLE]] if the object exists already exists or the current object's handle is [[OS2 API:DataType:NULLHANDLE|NULLHANDLE]].
+[[HOBJECT]] of the object moved or [[NULLHANDLE]] if the object exists already exists or the current object's handle is NULLHANDLE.
 <!--
 OR
@@ Line 20: / Line 20: @@
 * [[OS2 API:DataType:FALSE|FALSE]]
 -->
-Returns from [[OS2 API:WinGetLastError|WinGetLastError]] should [[OS2 API:WinMoveObject|WinMoveObject]] fail:
+Returns from [[WinGetLastError]] should [[WinMoveObject]] fail:
 * [[OS2_API:PMI:error#WPERR_ALREADY_EXISTS|WPERR_ALREADY_EXISTS]]
 * [[OS2_API:PMI:error#WPERR_INVALID_FLAGS|WPERR_INVALID_FLAGS]]
@@ Line 36: / Line 36: @@
 === Example Code ===
   ...
-  [[OS2 API:DataType:HOBJECT|HOBJECT]] moveObject;
+  HOBJECT moveObject;
-  [[OS2 API:DataType:HOBJECT|HOBJECT]] destinationObject;
+  HOBJECT destinationObject;
-  [[OS2 API:DataType:ULONG|ULONG]] option;
+  ULONG option;
-  [[OS2 API:DataType:HOBJECT|HOBJECT]] rc;
+  HOBJECT rc;
   ...
   rc = WinMoveObject (moveObject, destinationObject, option);
@@ Line 45: / Line 45: @@
 === Related Functions ===
-[[OS2 API:WinCreateObject|WinCreateObject]]
+*[[WinCreateObject]]
-[[OS2 API:WinQueryObject|WinQueryObject]]
+*[[WinQueryObject]]
-[[OS2 API:WinCopyObject|WinCopyObject]]
+*[[WinCopyObject]]
-[[OS2 API:WinSaveObject|WinSaveObject]]
+*[[WinSaveObject]]
-[[OS2 API:WinOpenObject|WinOpenObject]]
+*[[WinOpenObject]]
-[[OS2 API:WinSetObjectData|WinSetObjectData]]
+*[[WinSetObjectData]]
 === Notes ===
-The REXX function is [[OS2 API:REXX:SysMoveObject|SysMoveObject]].
+The REXX function is [[SysMoveObject]].
 === OS Version Introduced ===
-OS/2 Warp 3.0 and above, eCS 1.0 and above
+*OS/2 Warp 3.0
-[[Category:The OS/2 API Project]]
+[[Category:Win]]