Share via


CeFlushDBVol (CEDB)

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This function flushes information from a database volume to permanent storage.

This function does not work with EDB databases. For more information, see EDB Functions.

Syntax

BOOL CeFlushDBVol( 
  PCEGUID pceguid
); 

Parameters

  • pceguid
    [in] Pointer to the CEGUID that contains the globally unique identifier (GUID) of a mounted volume to be flushed. If this parameter is set to NULL, all database volumes that have been mounted are flushed.

Return Value

TRUE indicates success. FALSE indicates failure. To get extended error information, call GetLastError.

Remarks

In a mounted database volume, all write operations are cached. To explicitly force the data to be written out to permanent storage, call this function. If a reset or power failure occurs before data is flushed from the cache, the data that has not been flushed is lost. The database engine periodically flushes the database volume when enough data has been changed, but an application that must be assured that its data is saved should call this functions. A database volume is also flushed when it is unmounted.

It is not necessary to call this function on the object store. Data written to the object store is not cached and persists as long as the object store persists.

Requirements

Header windbase.h
Library coredll.lib
Windows Embedded CE Windows CE 2.10 and later

See Also

Reference

CEDB Functions
CeUnmountDBVol (CEDB)
CeWriteRecordProps (CEDB)