WinSaveObject: Difference between revisions

← Older edit Newer edit →

Revision as of 19:24, 8 December 2016

WinSaveObject

WinSaveObject(objectHndl, asynchronousFlag): Saves the state of the object.

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 conversion

Cdecl32

Example Code

...
HOBJECT hobj;
BOOL    fAsync;
BOOL    rc;
...
rc = WinSaveObject (hobj, fAsync);
...

Related Functions

Notes

Asynchronously saved object are saved in a separate thread. This is the prefered way. Otherwise, synchronouly, 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

@@ Line 1: / Line 1: @@
-#REDIRECT [[OS2 API:PMI:WinSaveObject]]
+== WinSaveObject ==
+; WinSaveObject(objectHndl, asynchronousFlag) : Saves the state of the object.
+=== 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 conversion ===
+[[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 prefered way.  Otherwise, synchronouly, 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]]