CeDeleteDatabase

The CeDeleteDatabase function removes a database from the object store. A RAPI version of this function exists and is also called CeDeleteDatabase.

Syntax

BOOL CeDeleteDatabase(CEOID oidDbase);

At a Glance

Header file: Winbase.h
Component: fsdbase
Platforms: H/PC
Windows CE versions: 1.01 and later

Parameters

oidDbase
Object identifier of the database to be deleted.

Return Values

If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. To get extended error information when within a CE program call GetLastError. If within a RAPI program, call CeGetLastError. GetLastError and CeGetLastError may return one of the following values:

ERROR_INVALID_PARAMETER
A parameter was invalid.
ERROR_SHARING_VIOLATION
Another thread has an open handle to the database.

Remarks

The CeDeleteDatabase function deletes a database, including all records in the database.

For more information, see Accessing Persistent Storage.

When writing applications for Windows CE version 1.0, use the PegDeleteDatabase function.

See Also

CeCreateDatabase, CeOidGetInfo