CeDeleteRecord (RAPI)

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function deletes a record from a database on a remote Windows Embedded CEā€“based device.

Syntax

BOOL CeDeleteRecord(
  HANDLE hDatabase, 
  CEOID oidRecord 
);

Parameters

  • hDatabase
    [in] Handle to the database from which the record is to be deleted. The database must be open. Open a database by calling the CeOpenDatabase function.
  • oidRecord
    [in] Object identifier of the record to be deleted, which is obtained from CeWriteRecordProps.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call CeGetLastError and CeRapiGetError. CeGetLastError may return ERROR_INVALID_PARAMETER if the handle or object identifier is invalid.

Remarks

If the CEDB_AUTOINCREMENT flag is not specified when the database is opened, and the record being deleted is the current record, the next read operation that uses the database handle will fail. If the CEDB_AUTOINCREMENT flag is specified, the system automatically moves the current seek pointer forward by one.

Note

Earlier versions of Windows Embedded CE assigned object identifiers to objects in other file systems, such as the file allocation table (FAT) file system. These object identifiers were guaranteed to be unique within a volume, but not across multiple volumes. Effective with version 3.0, only objects in the object store have valid, unique object identifiers and the object store is the only volume that can return an object identifier.

Requirements

Header rapi.h
Library rapi.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2000 and later, Smartphone 2002 and later

See Also

Reference

RAPI Functions
CeOpenDatabase (RAPI)