WinSaveObject: Difference between revisions
Appearance
WinSaveObject moved to OS2 API:WinSaveObject |
mNo edit summary |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
Saves the state of the object. | |||
==Syntax== | |||
WinSaveObject(objectHndl, asynchronousFlag) | |||
===Parameters=== | |||
; objectHndl - [[HOBJECT]] - input : The object handle. | |||
; asynchronousFlag - [[BOOL]] - input : To save the object asynchronously or not. | |||
===Returns=== | |||
This function returns a [[BOOL]] with the values of: | |||
* [[TRUE]] | |||
* [[FALSE]] | |||
=== Define (C/C++) === | |||
INCL_WINWORKPLACE | |||
=== Calling Convention === | |||
[[Cdecl32]] | |||
=== Example Code === | |||
... | |||
HOBJECT hobj; | |||
BOOL fAsync; | |||
BOOL rc; | |||
... | |||
rc = WinSaveObject (hobj, fAsync); | |||
... | |||
==Related Functions== | |||
*[[WinCopyObject]] | |||
*[[WinCreateObject]] | |||
*[[WinDestroyObject]] | |||
*[[WinMoveObject]] | |||
*WinQueryObjectWindow | |||
==Notes== | |||
Asynchronously saved object are saved in a separate thread. This is the preferred way. Otherwise, synchronously, the object is save on the user interface thread. | |||
Using [[HOBJECT]] for .INI files or files in which an application uses a rename/save/delete sequence is not supported. | |||
=== OS Version Introduced === | |||
OS/2 Warp 3.0 | |||
[[Category:Win]] |
Latest revision as of 11:27, 2 March 2018
Saves the state of the object.
Syntax
WinSaveObject(objectHndl, asynchronousFlag)
Parameters
- objectHndl - HOBJECT - input
- The object handle.
- asynchronousFlag - BOOL - input
- To save the object asynchronously or not.
Returns
This function returns a BOOL with the values of:
Define (C/C++)
INCL_WINWORKPLACE
Calling Convention
Example Code
... HOBJECT hobj; BOOL fAsync; BOOL rc; ... rc = WinSaveObject (hobj, fAsync); ...
Related Functions
- WinCopyObject
- WinCreateObject
- WinDestroyObject
- WinMoveObject
- WinQueryObjectWindow
Notes
Asynchronously saved object are saved in a separate thread. This is the preferred way. Otherwise, synchronously, the object is save on the user interface thread.
Using HOBJECT for .INI files or files in which an application uses a rename/save/delete sequence is not supported.
OS Version Introduced
OS/2 Warp 3.0