WinMoveObject: Difference between revisions
m →Returns |
mNo edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 5: | Line 5: | ||
== Parameters == | == Parameters == | ||
;moveObject | ;moveObject ([[HOBJECT]]) - input : Handle of the object to be moved. | ||
;destinationObject | ;destinationObject (HOBJECT) - input : Handle of the destination folder to move the moveObject into. | ||
;option | ;option ([[ULONG]]) - input : The only supported option is CO_FAILIFEXISTS. | ||
== Constants == | == Constants == | ||
| Line 14: | Line 14: | ||
== Returns == | == Returns == | ||
<!-- From the toolkit API doc: --> | <!-- 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. | |||
<!-- | <!-- | ||
OR | OR | ||
from OS/2 Warp Presentation Manager API book: | from OS/2 Warp Presentation Manager API book: | ||
2. True if successful, false if not successful. | 2. True if successful, false if not successful. | ||
* | * TRUE | ||
* | * FALSE | ||
--> | --> | ||
Returns from [[WinGetLastError]] should WinMoveObject fail: | Returns from [[WinGetLastError]] should WinMoveObject fail: | ||
Latest revision as of 14:09, 26 October 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
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