WinMoveObject: Difference between revisions
Appearance
mNo edit summary |
|||
(2 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
WinMoveObject(moveObject, destinationObject, option) | WinMoveObject(moveObject, destinationObject, option) | ||
== 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 == | |||
*CO_FAILIFEXISTS | *CO_FAILIFEXISTS | ||
== 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. | [[HOBJECT]] of the object moved or [[NULLHANDLE]] if the object exists already exists or the current object's handle is NULLHANDLE. | ||
Line 23: | Line 23: | ||
--> | --> | ||
Returns from [[WinGetLastError]] should WinMoveObject fail: | Returns from [[WinGetLastError]] should WinMoveObject fail: | ||
* [[ | * [[PM Error Codes#WPERR_ALREADY_EXISTS|WPERR_ALREADY_EXISTS]] | ||
* [[ | * [[PM Error Codes#WPERR_INVALID_FLAGS|WPERR_INVALID_FLAGS]] | ||
== Define (C/C++) == | |||
INCL_WINWORKPLACE | INCL_WINWORKPLACE | ||
== Calling Convention == | |||
[[Cdecl32]] | [[Cdecl32]] | ||
== Example Code == | |||
... | ... | ||
HOBJECT moveObject; | HOBJECT moveObject; | ||
Line 42: | Line 42: | ||
... | ... | ||
== Related Functions == | |||
*[[WinCreateObject]] | *[[WinCreateObject]] | ||
*[[WinQueryObject]] | *[[WinQueryObject]] | ||
Line 50: | Line 50: | ||
*[[WinSetObjectData]] | *[[WinSetObjectData]] | ||
== Notes == | |||
The REXX function is ''SysMoveObject''. | The REXX function is ''SysMoveObject''. | ||
== OS Version Introduced == | |||
*OS/2 Warp 3.0 | *OS/2 Warp 3.0 | ||
[[Category:Win]] | [[Category:Win]] |
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
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