WinMoveObject: Difference between revisions
Appearance
m changed constant namespace |
m formatting |
||
Line 1: | Line 1: | ||
== WinMoveObject == | == WinMoveObject == | ||
; WinMoveObject(moveObject, destinationObject, option) : | ; WinMoveObject(moveObject, destinationObject, option) : Moves object from one location to the desired location. | ||
Moves object from one location to the desired location. | |||
=== Parameters === | === Parameters === | ||
; moveObject - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : | ; moveObject - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : Handle of the object to be moved. | ||
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 - [[OS2 API:DataType:HOBJECT|HOBJECT]] - input : | ; option - [[OS2 API:DataType:ULONG|ULONG]] - input : The only supported option is [[OS2 API:Constant:CO#CO_FAILIFEXISTS|CO_FAILIFEXISTS]]. | ||
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]]. | |||
=== Constants === | === Constants === |
Revision as of 04:59, 1 May 2006
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
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
Example Code
... HOBJECT moveObject; HOBJECT destinationObject; ULONG option; HOBJECT rc; ... rc = WinMoveObject (moveObject, destinationObject, option); ...
Related Functions
WinCreateObject WinQueryObject WinCopyObject WinSaveObject WinOpenObject WinSetObjectData
Notes
The REXX function is SysMoveObject.
OS Version Introduced
OS/2 Warp 3.0 and above, eCS 1.0 and above